| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 11b8e4e commit a3782cd
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -399,11 +399,14 @@ expression in the Matplotlib figure. In these cases, you can use the | |||
| 399 | 399 | ||
| 400 | 400 | .. _writing-docstrings: | |
| 401 | 401 | ||
| 402 | - Write docstrings | ||
| 403 | - ================ | ||
| 402 | + Write API documentation | ||
| 403 | + ======================= | ||
| 404 | 404 | ||
| 405 | - Most of the API documentation is written in docstrings. These are comment | ||
| 406 | - blocks in source code that explain how the code works. | ||
| 405 | + The API reference documentation describes the library interfaces, e.g. inputs, outputs, | ||
| 406 | + and expected behavior. Most of the API documentation is written in docstrings. These are | ||
| 407 | + comment blocks in source code that explain how the code works. All docstrings should | ||
| 408 | + conform to the `numpydoc docstring guide`_. Much of the ReST_ syntax discussed above | ||
| 409 | + (:ref:`writing-rest-pages`) can be used for links and references. | ||
| 407 | 410 | ||
| 408 | 411 | .. note:: | |
| 409 | 412 | ||
@@ -412,11 +415,11 @@ blocks in source code that explain how the code works. | |||
| 412 | 415 | you may see in the source code. Pull requests updating docstrings to | |
| 413 | 416 | the current style are very welcome. | |
| 414 | 417 | ||
| 415 | - All new or edited docstrings should conform to the `numpydoc docstring guide`_. | ||
| 416 | - Much of the ReST_ syntax discussed above (:ref:`writing-rest-pages`) can be | ||
| 417 | - used for links and references. These docstrings eventually populate the | ||
| 418 | - :file:`doc/api` directory and form the reference documentation for the | ||
| 419 | - library. | ||
| 418 | + The pages in :file:`doc/api` are purely technical definitions of | ||
| 419 | + layout; therefore new API reference documentation should be added to the module | ||
| 420 | + docstrings. This placement keeps all API reference documentation about a module in the | ||
| 421 | + same file. These module docstrings eventually populate the :file:`doc/api` directory | ||
| 422 | + and form the reference documentation for the library. | ||
| 420 | 423 | ||
| 421 | 424 | Example docstring | |
| 422 | 425 | ----------------- | |
| Back | FazBrowse Home | New Git URL |
0 commit comments