diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-27 01:46:22 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-27 01:46:22 +0900 |
| commit | fbdfade0687e67af2d822c830cf5ace8a53ed7aa (patch) | |
| tree | 6cc7c2b96453d90893c240ef213a7f04c4769767 /doc/usage/extensions/example_google.py | |
| parent | 3816bcdfa9cf65f9af6c70bbf7837fd51841ddfa (diff) | |
| download | sphinx-git-fbdfade0687e67af2d822c830cf5ace8a53ed7aa.tar.gz | |
doc: Use :pep: role to refer PEP documents
Diffstat (limited to 'doc/usage/extensions/example_google.py')
| -rw-r--r-- | doc/usage/extensions/example_google.py | 8 |
1 files changed, 2 insertions, 6 deletions
diff --git a/doc/usage/extensions/example_google.py b/doc/usage/extensions/example_google.py index aacc768dc..6f82a2e5f 100644 --- a/doc/usage/extensions/example_google.py +++ b/doc/usage/extensions/example_google.py @@ -45,7 +45,7 @@ on the first line, separated by a colon. def function_with_types_in_docstring(param1, param2): """Example function with types documented in the docstring. - `PEP 484`_ type annotations are supported. If attribute, parameter, and + :pep:`484` type annotations are supported. If attribute, parameter, and return types are annotated according to `PEP 484`_, they do not need to be included in the docstring: @@ -55,10 +55,6 @@ def function_with_types_in_docstring(param1, param2): Returns: bool: The return value. True for success, False otherwise. - - .. _PEP 484: - https://peps.python.org/pep-0484/ - """ @@ -311,4 +307,4 @@ class ExamplePEP526Class: """ attr1: str - attr2: int
\ No newline at end of file + attr2: int |