diff options
| author |  Hassan Abouelela <[email protected]> | 2021-12-03 01:01:40 +0400 |
|---|---|---|
| committer | Hassan Abouelela <[email protected]> | 2021-12-03 01:01:40 +0400 |
| commit | e465278e0e325b31c268fba3d634c27773637f0d (patch) | |
| tree | 59797ffcf897322aff6696a6354684f28e8fa3c5 | |
| parent | Add Documentation Deploy Action (diff) | |
Reword Unclear Statement in Docs
| -rw-r--r-- | docs/README.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index c1ff6359..06c5a739 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,7 +23,7 @@ Neither of these two tasks needs to be manually called, as the `docs` task calls ## Docstrings -To have your code probably documented, you need to do a couple of things: +To have your code properly added to the generated docs, you need to do a couple of things: 1. Write your code with annotations. 2. [Write your docstring, using the Google docstring format][google] @@ -40,5 +40,6 @@ Each change requires an entry in the [Changelog](./changelog.rst). Refer to the [Releases][releases] documentation for more information on the exact format and content of entries You can use [this site][releases] to get the PR number you'll use for your entry. + [next]: https://ichard26.github.io/next-pr-number/?owner=python-discord&name=bot-core [releases]: https://releases.readthedocs.io/en/latest/concepts.html |