coretasks: trying to improve docstrings #2001
Merged
Conversation
This file contains hidden or 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
requested changes
Dec 14, 2020
Member
dgw
left a comment
dgw
left a comment
There was a problem hiding this comment.
OK, this ended up a bit scarier in terms of line-note count than I expected based on the diff size. It's pretty much all trivial stuff, though. I like!
Contributor
Author
Maybe you didn't notice but I tried hard to not forget about S everywhere. Also, I think I more or less remembered that "plurals' something" and not "plurals's something". |
Exirel
force-pushed
the
coretasks-docstrings
branch
from
6171b37 to
cd43d1e
Compare
26 tasks
Exirel
force-pushed
the
coretasks-docstrings
branch
from
cd43d1e to
81cf6d6
Compare
Contributor
Author
|
Fixed conflict and repushed. |
Member
|
I'm going to trust that Exi's rebase didn't break anything. Did skim the current changes, but not in-depth. (Who wants to re-review things? Not this dgw!) |
dgw
approved these changes
Jan 15, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Working on #1565, for the
coretaskscore plugin. I wanted to do a quick first draft for @dgw to review.I'm not really proud of these docstrings. On the other hand, I think we need a full chapter to explain how Sopel initialize the connection, deal with SASL, WHO/WHOX/NAMES, and stuffs. So it's not really my biggest concern.
My biggest concern is the lack of test for this plugin. I might add them here, maybe. We'll see.
Checklist
make qa(runsmake qualityandmake test)