Skip to content

Commit

Permalink
Refactor Python docstring format
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilipMay committed Jan 2, 2024
1 parent 8541279 commit bc9ea51
Showing 1 changed file with 1 addition and 11 deletions.
12 changes: 1 addition & 11 deletions source/python/docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,7 @@

## Description

Python docstrings can be written in many different formats. An overview
of different methods can be found in the following Stack Overflow entry:
[What is the standard Python docstring
format?](https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format)

It seems to be clever to use the docstring format of scipy and numpy
since these packages are very popular. A guide to the numpy docstring
format is here: [numpydoc docstring
guide](https://numpydoc.readthedocs.io/en/latest/) and here is a
[Restructured Text (reST) syntax CheatSheet for
Sphinx](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html).
- overview different docstring methods: [What is the standard Python docstring format?](https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format)

## Links

Expand Down

0 comments on commit bc9ea51

Please sign in to comment.