Merge pull request #210 from njoy/fix/documentation

fixing typo in documentation

Author: whaeck

ReleaseNotes.md

@@ -2,7 +2,7 @@
 Given here are some release notes for ENDFtk.
 
 ## [ENDFtk v1.1.1](https://github.com/njoy/ENDFtk/pull/xxx)
-This update removes the regions() and pairs() interface functions on the TAB1 record interface functions that are unused. The removal of these interface functions has no impact on the Python interface as these interface functions were not included on the Python side.
+This update removes the regions() and pairs() interface functions on the TAB1 record interface functions that are unused. The removal of these interface functions has no impact on the Python interface as these interface functions were not included on the Python side. Miscellaneous documentation updates were made as well.
 
 In addition, the following issues were corrected:
   - A minor bug in the rectangular matrix covariance block was corrected. The values for the row and column energies are lifted out of a larger array using the std::ranges::take and std::ranges::drop function. For the column energies, we forgot to properly end the sequence. As a result, the end() iterator of the range did not point to the end of the column energies but to the end of the covariance values, which is now corrected.

python/src/section/2/151/ResonanceRange.python.cpp

@@ -40,16 +40,16 @@ void wrapResonanceRange( python::module& module, python::module& ) {
     python::arg( "parameters" ), python::arg( "scattering_radius" ) = std::nullopt,
     "Initialise the component\n\n"
     "Arguments:\n"
-    "    self                the component\n"
-    "    el                  the lower energy of the resonance region\n"
-    "    eh                  the upper energy of the resonance region\n"
-    "    naps                the flag to indicate then on how to calculate\n"
-    "                        the scattering radius (0 or 1 if no energy\n"
-    "                        dependent scattering radius is given and 0, 1\n"
-    "                        or 2 if energy dependent scattering radius is\n"
-    "                        given)\n"
-    "    parameters          the resonance parameters\n"
-    "    scatteringRadius    An optional energy dependent scattering radius"
+    "    self                 the component\n"
+    "    el                   the lower energy of the resonance region\n"
+    "    eh                   the upper energy of the resonance region\n"
+    "    naps                 the flag to indicate then on how to calculate\n"
+    "                         the scattering radius (0 or 1 if no energy\n"
+    "                         dependent scattering radius is given and 0, 1\n"
+    "                         or 2 if energy dependent scattering radius is\n"
+    "                         given)\n"
+    "    parameters           the resonance parameters\n"
+    "    scattering_radius    An optional energy dependent scattering radius"
   )
   .def_property_readonly(