Skip to content

Commit 4621c2a

Browse files
Update docstring.md (#34560)
1 parent a750b58 commit 4621c2a

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

doc/dev/docstring.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
All public methods should have docstrings to document the parameters, keywords, exceptions raised, and return types for each method. Models and clients should also document properties, instance variables, and class variables.
44

55
* [Docstrings](#docstrings)
6-
* [Method Docstrings](#method_docstrings)
7-
* [Model and Client Docstrings](#model_and_client_docstrings)
8-
6+
* [Method Docstrings](#method-docstrings)
7+
* [Model and Client Docstrings](#model-and-client-docstrings)
8+
* [Additional references](#additional-references)
99

1010
## Docstrings
1111

@@ -190,3 +190,8 @@ class DocumentTranslationInput(object): # pylint: disable=useless-object-inheri
190190
```
191191

192192
Positional parameters and keyword arguments are documented in the exact same way as a client method would be, using the `param` and `keyword` descriptors. Although not required, a new line between `param` and `keyword` descriptors helps to separate the docstring into logically separated groups.
193+
194+
## Additional references
195+
196+
- [Official Sphinx documentation](https://www.sphinx-doc.org/en/master/usage/domains/python.html)
197+
- [Microsoft - How to document a Python API (internal)](https://github.com/MicrosoftDocs/docs-help-pr/blob/main/help-content/onboard/admin/reference/python/documenting-api.md)

0 commit comments

Comments
 (0)