Fix up some docstrings for 6.6.x #1589
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
Exirel
requested changes
May 8, 2019
dgw
commented
May 8, 2019
Co-authored-by: Florian Strzelecki <florian.strzelecki@gmail.com>
Bad formatting/missing cross-references/incorrect information fixed. What a doozy, that `Channel.users` was documented as containing a map of `Identifier`s to `Channel` objects... That's pretty bad! Co-authored-by: Florian Strzelecki <florian.strzelecki@gmail.com>
Replacing "Willie" with "Sopel" literally *everywhere* was a bad choice. Some references to "Willie" should stay. Note that this nested formatting doesn't even *work* in Sphinx (inline formatting can't be nested, for some silly reason), but since this whole docstring is already overhauled completely on `master` I'll just fix the typo for 6.6.x and leave the rest to 7.0.
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.
While I was using the live website over the weekend to reference Sopel's API docs, some annoyances jumped out at me in the page about other API features (formatting, various tools).
Today, I decided to fix them. Most of this is touching stuff that hasn't been overhauled (#1565) yet, but I'll probably have to deal with a merge conflict or two on stuff in
toolsthat I did already fix in #1563. It's worth doing so our live site can have a bit better content—especially since I fixed an actual mistake!