frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated Docstring Guidelines (markdown)

Svetlana Karslioglu
2025-06-09 08:16:31 -07:00
parent d465213694
commit eb414d0f6e
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Docstring-Guidelines.md

@ -259,6 +259,16 @@ See [MyST Markdown documentation](https://myst-parser.readthedocs.io/en/v0.15.1/
Below is a quick reference of how to use MyST Markdown.
### Autodoc directives
| reSTructuredText| Purpose | MyST Markdown |
|-----------|---------|---------|
| `:class:` | Reference a class | {class}\`MyClass\` |
| `:func:` | Reference a function | {func}\`my_module.my_function\` |
| `:meth:` | Reference a method | {meth}\`MyClass.my_method\` |
| `:mod:` | Reference a module | {mod}\`my_module\` |
### Python References
| reSTructuredText| Purpose | MyST Markdown |
@ -272,6 +282,7 @@ Below is a quick reference of how to use MyST Markdown.
| `:py:exc:` | Reference an exception | {py:exc}\`MyException\` |
| `:py:obj:` | Reference any Python object | {py:obj}\`my_module.MyClass.my_function\` |
### Auto-Documentation Directives
Autodoc and autosummary directives should be wrapped in the `{eval-rst}` directive.