Doc fixes

jzuhone · May 2, 2024 · 57c3a23 · 57c3a23
1 parent e1c5ac4
commit 57c3a23
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst
@@ -3,6 +3,26 @@
 ChangeLog
 =========
 
+Version 4.8.4
+-------------
+
+This version of SOXS fixes two bugs and one documentation error.
+
+* Spatial region handling in the context of :func:`~soxs.events.filter_events` and
+  :func:`~soxs.events.write_spectrum` has been fixed for composite regions which
+  mixed regions which include and exclude data.
+* When creating spectra using :func:`~soxs.instrument.simulate_spectrum` and
+  including backgrounds, the square root of the ``bkgnd_area`` parameter was
+  used to normalize the backgrounds instead of the ``bkgnd_area`` parameter itself.
+  This has been fixed. Thanks to `liuguanfu1120 <https://github.com/liuguanfu1120>`_
+  for pointing this out in
+  `Github Issue #36 <https://github.com/lynx-x-ray-observatory/soxs/issues/36>`_.
+* The :ref:`background` page incorrectly reported ``"wabs"`` as the default
+  absorption model for the Milky Way foreground, instead of ``"tbabs"``. This has
+  been corrected. Thanks to `liuguanfu1120 <https://github.com/liuguanfu1120>`_
+  for pointing this out in
+  `Github Issue #35 <https://github.com/lynx-x-ray-observatory/soxs/issues/35>`_.
+
 Version 4.8.3
 -------------
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -78,9 +78,9 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-version = "4.8.3"
+version = "4.8.4"
 # The full version, including alpha/beta/rc tags.
-release = "4.8.3"
+release = "4.8.4"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -69,7 +69,7 @@ SOXS is released under a `BSD 3-clause license <https://opensource.org/licenses/
 Current Version
 ---------------
 
-The current stable version is 4.8.3. See the :ref:`changelog` for details on changes
+The current stable version is 4.8.4. See the :ref:`changelog` for details on changes
 from previous versions.
 
 Documentation Contents

diff --git a/doc/source/users_guide/background.rst b/doc/source/users_guide/background.rst
@@ -25,7 +25,7 @@ The ``"default"`` galactic foreground component is modeled as a sum of two
 thermal models with thermal broadening of emission lines, one absorbed,
 ``bapec+tbabs*bapec``, with parameters:
 
-``wabs*bapec`` **Model 1, Hot Halo**
+``tbabs*bapec`` **Model 1, Hot Halo**
 
 * ``nH``: :math:`0.018 \times 10^{22}~\rm{cm}^{-2}`
 * ``kT``: :math:`\rm{0.225~keV}`