Improve model classes docstrings

SDXorg · Dec 22, 2023 · 0a25e04 · 0a25e04
1 parent bf896cd
commit 0a25e04
Show file tree

Hide file tree

Showing 2 changed files with 187 additions and 38 deletions.
diff --git a/docs/whats_new.rst b/docs/whats_new.rst
@@ -17,13 +17,17 @@ Bug fixes
 
 Documentation
 ~~~~~~~~~~~~~
+- Improve documentation of methods in :py:class:`pysd.py_backend.model.Model` and :py:class:`pysd.py_backend.model.Macro` includying cross-references and rewrite the one from :py:meth:`pysd.py_backend.model.Macro.set_components`. (`@enekomartinmartinez <https://github.com/enekomartinmartinez>`_)
 
 Performance
 ~~~~~~~~~~~
 - Improved performace of :py:class:`pysd.py_backend.output.DataFrameHandler` by creating the dataframe at the end of the run (:issue:`374`). (`@easyas314159 <https://github.com/easyas314159>`_ and `@enekomartinmartinez <https://github.com/enekomartinmartinez>`_)
 
 Internal Changes
 ~~~~~~~~~~~~~~~~
+- Move old :py:meth:`pysd.py_backend.model.Macro.set_components` to :py:meth:`pysd.py_backend.model.Macro._set_components`, and create new method with the same name without the `new` argument.
+
+- Move old :py:meth:`pysd.py_backend.model.Macro.set_stateful` to :py:meth:`pysd.py_backend.model.Macro._set_stateful`.
 
 v3.12.0 (2023/10/02)
 --------------------