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

added example.py

parent 3e19abcb

README.md

+1 −0
Original line number Diff line number Diff line
@@ -118,6 +118,7 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f 
- Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html

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

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

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

- `unittest`: https://docs.python.org/3.8/library/unittest.html

- gitlab CI/CD pipeline: https://docs.gitlab.com/ee/ci/pipelines/

- gitlab runners: https://docs.gitlab.com/runner/

examples/how_to_write_docstring.py

+5 −0
Original line number Diff line number Diff line
@@ -34,5 +34,10 @@ def cos(x: float = 0.) -> float: 
    Notes

    -----

    this function is a warpper of `numpy.cos()`



    Conf

    ----

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



    """

    return np.cos(x)