diff options
| author |  ChrisJL <[email protected]> | 2021-07-23 11:17:43 +0100 |
|---|---|---|
| committer |  GitHub <[email protected]> | 2021-07-23 11:17:43 +0100 |
| commit | fb7ec43edc0581175cb86fed7df48ef7efb6e743 (patch) | |
| tree | 660a4ebdd7cbc116aeb5ba80d52f14555b01b055 | |
| parent | Move type docs to type hints (diff) | |
Refer to PEP-257 as the official spec
This is for users who may not know what a PEP is.
Co-authored-by: Bluenix <[email protected]>
| -rw-r--r-- | bot/resources/tags/docstring.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/bot/resources/tags/docstring.md b/bot/resources/tags/docstring.md index 7144d3702..8d6fd3615 100644 --- a/bot/resources/tags/docstring.md +++ b/bot/resources/tags/docstring.md @@ -13,4 +13,4 @@ def greet(name: str, age: int) -> str: ``` You can get the docstring by using the `.__doc__` attribute. For the last example, you can print it by doing this: `print(greet.__doc__)`. -For more details about what a docstring is and its usage, check out this guide by [Real Python](https://realpython.com/documenting-python-code/#docstrings-background), or the [PEP-257 docs](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring). +For more details about what a docstring is and its usage, check out this guide by [Real Python](https://realpython.com/documenting-python-code/#docstrings-background), or the [official docstring specification](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring). |