tools: Overhaul docstrings #1563
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
dgw
force-pushed
the
sopel.tools-docstring-cleanup
branch
from
d54c307 to
5129b60
Compare
Exirel
requested changes
Apr 21, 2019
|
@Exirel Pushed all my changes based on your review without rebasing, so you can see them more easily. Also fixed a related conflict between the |
dgw
force-pushed
the
sopel.tools-docstring-cleanup
branch
from
ab857d7 to
ffebe06
Compare
|
Unrelated decorator breakage sorted, and it turns out we don't need that monkey-patch I added into Sphinx's config in a previous version of this branch. Good to re-review 👍 |
Exirel
approved these changes
Apr 22, 2019
|
🚢 |
It started from noticing some extra blank lines and a few typos, and snowballed into this reasonably large changeset. Sometimes I just can't stop fixing documentation once I start…
The way it worked before, Sphinx would output `**kwargs` as the function parameters for methods decorated with `deprecated`, instead of the real signature. Not surprising, I guess, given what the code was doing. As for why we weren't already using functools.wraps in the decorator itself, it's been around since the root commit of this repo, ten years ago, back when this project was still named "Jenni". The functools module was added in Python 2.5, but maybe this decorator was originally added before that version came out? We might never know, but let's use the modern way from now on!
dgw
force-pushed
the
sopel.tools-docstring-cleanup
branch
from
ffebe06 to
bc98c38
Compare
|
Squished. Waiting for Travis… |
26 tasks
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.
It started from noticing some extra blank lines and a few typos, and snowballed into this reasonably large changeset. Sometimes I just can't stop fixing documentation once I start…
This might or might not get added onto. I only touched
tools/__init__.pyso far, and haven't looked at any of the subpackages. (webis safe until #1318 gets sorted—that branch is still WIP, but largely done.)Officially marking the
SopelMemory.contains()method (and its fraternal twin inSopelMemoryWithDefault) as deprecated felt really good. Can't wait to get rid of them for good…