chore: added news for docstring

bobleesj · bobleesj · commit 5dfff333783e · 2024-12-31T09:28:20.000-05:00
diff --git a/news/docstrings-refactor.rst b/news/docstrings-refactor.rst
@@ -1,6 +1,6 @@
 **Added:**
 
-* No news added: this branch was used to refactor the docstrings in the codebase without adding new features
+* Improved API documentation in `DiffractionObject` methods and properties using the NumPy docstring format and PEP 256
 
 **Changed:**
 
diff --git a/src/diffpy/utils/diffraction_objects.py b/src/diffpy/utils/diffraction_objects.py
@@ -190,7 +190,7 @@ def __add__(self, other):
         Returns
         -------
         DiffractionObject
-            THe new DiffractionObject instance with modified yarray values. This instance is a deep copy of the
+            The new DiffractionObject instance with modified yarray values. This instance is a deep copy of the
             original with the additions applied.
 
         Raises
