module: docstring overhaul & modernization #1770
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 tasks
dgw
force-pushed
the
module-doc-overhaul
branch
from
c97fb96 to
6dd12e5
Compare
|
Can't believe I missed one little change. Had to fix, or Sphinx throws errors when building docs. |
Exirel
approved these changes
Dec 1, 2019
Part of the ongoing effort to standardize (as best we can) Sopel's docstring formatting and make use of Sphinx features to enhance the public API documentation site. See #1565.
dgw
force-pushed
the
module-doc-overhaul
branch
from
6dd12e5 to
8092b61
Compare
|
@Exirel I just updated this with small consistency tweaks, but I don't think you need to re-review. 🙌 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of the ongoing effort to standardize (as best we can) Sopel's docstring formatting and make use of Sphinx features to enhance the public API documentation site. See #1565.
I blame @deathbybandaid for reminding me earlier this week that
@action_commandsdidn't have a note in the docs about its current mutual exclusivity with the other command decorators. 😝