Commit 80a4ae33 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

tweaks

parent 0777aaab

doc/source/api/csst_proto.rst

+1 −0
Original line number Original line Diff line number Diff line
@@ -2,6 +2,7 @@ API 
===

===





.. automodule:: csst_proto.top_level_interface

.. automodule:: csst_proto.top_level_interface

   :noindex:

   :members:

   :members:

   :undoc-members:

   :undoc-members:

   :show-inheritance:
 
   :show-inheritance:

doc/source/codestyle.rst

+33 −4
Original line number Original line Diff line number Diff line
@@ -39,10 +39,24 @@ Files/directories with asterisks (*) marks are optional. 
Code Style

Code Style

==========

==========

Python code should follow PEP 8

Python code should follow PEP 8



- https://peps.python.org/pep-0008/

- https://peps.python.org/pep-0008/



Whereas C/C++ code should follow PEP 7

Whereas C/C++ code should follow PEP 7



- https://peps.python.org/pep-0007/

- https://peps.python.org/pep-0007/





Many IDEs (Pycharm, etc) and tools can be used to validate code style



- pycodestyle:

    - https://pycodestyle.pycqa.org/en/latest/



In our case, we recommend the following method to check code style



.. code-block:: bash



    pycodestyle ./**/*.py --ignore=E121,E123,E126,E226,E24,E704,W503,W504,E501,E722







Numpy-style docstring

Numpy-style docstring

=====================

=====================
@@ -50,10 +64,25 @@ There are several popular docstring styles, namely Google, reStructuredText, and 
The CSST DAS adopts Numpydoc-style among the three.

The CSST DAS adopts Numpydoc-style among the three.

We refer our developers to the Numpydoc official style guide for instructions on

We refer our developers to the Numpydoc official style guide for instructions on

how to write docstrings.

how to write docstrings.



- https://numpydoc.readthedocs.io/en/latest/format.html

- https://numpydoc.readthedocs.io/en/latest/format.html



In particular, a complete example is available here.

In particular, a complete example is available here.



- https://numpydoc.readthedocs.io/en/latest/example.html

- https://numpydoc.readthedocs.io/en/latest/example.html





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}



For example,



.. code-block:: bash



    python -m numpydoc --validate csst_proto.top_level_interface.flip_image







Markup language

Markup language

===============

===============