tools: subpackage doc overhaul #1771
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
Exirel
reviewed
Dec 3, 2019
Exirel
approved these changes
Dec 12, 2019
Most of this will never actually appear in the docs due to `__all__` and/or method privacy, but I updated things anyway. The ASCII art tables are kinda nice...
Easy by comparison with the mostly-hidden mess in `tools.calculation`. Almost theraputic doing this one!
Not much to do here. This is all internal and not shown in the public documentation, so the changes are solely to scratch my own itch for consistency between docstrings.
This was mostly already modernized, which made my life easy.
Fixed a malformatted return type annotation, and told Sphinx to include both static methods (technically private) in the public documentation so the migration guide for Sopel 7 can link to them.
dgw
force-pushed
the
tools-doc-overhaul
branch
from
af5031e
to
d6de3e0
Compare
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.
Tin. See #1565.
I was surprised that
tools.calculationtook the most time, which was probably mostly wasted on docstrings that don't appear in the public docs anyway, but pretty tables are always worth it… right? 😁