Commit fd859e1e authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

tweaks

parent cf2c31a6

docs/source/api/csst_proto.rst

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ API 
In this chapter, we show what the rendered Numpy-style docstring looks like

in sphinx documentation.



.. automodule:: csst_proto.top_level_interface

.. automodule:: csst_proto.api

   :noindex:

   :members:

   :undoc-members:

docs/source/ch04_codestyle.rst

+1 −1
Original line number Diff line number Diff line
@@ -96,7 +96,7 @@ In our case, we recommend the following method to check docstring 


.. code-block:: bash



    python -m numpydoc --validate {YOUR_PACKAGE}.top_level_interface.{YOUR_FUNCTION/CLASS}

    python -m numpydoc --validate {YOUR_PACKAGE}.api.{YOUR_FUNCTION/CLASS}



For example,