From 60140f804a17363d70f83263cbc6cf7b4634f1b9 Mon Sep 17 00:00:00 2001
From: Ray Yang <mingrui.yang@outlook.com>
Date: Fri, 1 Dec 2023 09:48:14 -0600
Subject: [PATCH 1/3] Fix formatting in some docstrings
---
src/BitStringAddresses/bosefs.jl | 2 +-
src/RimuIO/RimuIO.jl | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/BitStringAddresses/bosefs.jl b/src/BitStringAddresses/bosefs.jl
index 3fdf808d8..7c8b32cb6 100644
--- a/src/BitStringAddresses/bosefs.jl
+++ b/src/BitStringAddresses/bosefs.jl
@@ -344,7 +344,7 @@ end
"""
bose_hubbard_interaction(address)
-Return Σ_i *n_i* (*n_i*-1) for computing the Bose-Hubbard on-site interaction (without the
+Return ``Σ_i *n_i* (*n_i*-1)`` for computing the Bose-Hubbard on-site interaction (without the
*U* prefactor.)
# Example
diff --git a/src/RimuIO/RimuIO.jl b/src/RimuIO/RimuIO.jl
index b7e011053..e5b5ea424 100644
--- a/src/RimuIO/RimuIO.jl
+++ b/src/RimuIO/RimuIO.jl
@@ -49,7 +49,7 @@ end
"""
RimuIO.load_df(filename; propagate_metadata = true, add_filename = true) -> DataFrame
-Load Arrow file into `DataFrame``. Optionally propagate metadata to `DataFrame` and
+Load Arrow file into `DataFrame`. Optionally propagate metadata to `DataFrame` and
add the file name as metadata.
See also [`RimuIO.save_df`](@ref).
From d576c172123cfeecf6004cb2382a2a324be59d93 Mon Sep 17 00:00:00 2001
From: Ray Yang <mingrui.yang@outlook.com>
Date: Fri, 1 Dec 2023 10:22:05 -0600
Subject: [PATCH 2/3] fix `bose_hubbard_interaction` math
---
src/BitStringAddresses/bosefs.jl | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/BitStringAddresses/bosefs.jl b/src/BitStringAddresses/bosefs.jl
index 7c8b32cb6..51114be93 100644
--- a/src/BitStringAddresses/bosefs.jl
+++ b/src/BitStringAddresses/bosefs.jl
@@ -344,7 +344,7 @@ end
"""
bose_hubbard_interaction(address)
-Return ``Σ_i *n_i* (*n_i*-1)`` for computing the Bose-Hubbard on-site interaction (without the
+Return ``Σ_i n_i (n_i-1)`` for computing the Bose-Hubbard on-site interaction (without the
*U* prefactor.)
# Example
From dcf32920696af39212029a815bfa68650cc6129a Mon Sep 17 00:00:00 2001
From: Joachim Brand <j.brand@massey.ac.nz>
Date: Sat, 2 Dec 2023 11:21:29 +1300
Subject: [PATCH 3/3] Update src/BitStringAddresses/bosefs.jl
Co-authored-by: mtsch <matijacufar@gmail.com>
---
src/BitStringAddresses/bosefs.jl | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/BitStringAddresses/bosefs.jl b/src/BitStringAddresses/bosefs.jl
index 51114be93..582b8d7dd 100644
--- a/src/BitStringAddresses/bosefs.jl
+++ b/src/BitStringAddresses/bosefs.jl
@@ -345,7 +345,7 @@ end
bose_hubbard_interaction(address)
Return ``Σ_i n_i (n_i-1)`` for computing the Bose-Hubbard on-site interaction (without the
-*U* prefactor.)
+``U`` prefactor.)
# Example