irc: annotate submodules with internal-use warnings #2386
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
The top-level docs page for `sopel.irc` did, in fact, have an inline note about the `irc` module being for internal use. That wouldn't catch the eye of someone landing on a submodule via search (internal or web), though. Seemed prudent to beef up the presentation to `.. warning::` and also add a notice to each submodule. Annotating `sopel.irc.isupport` was extra fun, because part of it *is* included in the bot's public API.
SnoopJ
approved these changes
Dec 11, 2022
Contributor
SnoopJ
left a comment
SnoopJ
left a comment
There was a problem hiding this comment.
Looks like a nice improvement to the docs, especially the addition of descriptions about the top-level purpose of these modules and references to what users should use where possible.
Exirel
approved these changes
Dec 12, 2022
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.
Description
The top-level docs page for
sopel.ircdid, in fact, have an inline note about theircmodule being for internal use. That wouldn't catch the eye of someone landing on a submodule via search (internal or web), though. Seemed prudent to beef up the presentation to.. warning::and also add a notice to each submodule.Annotating
sopel.irc.isupportwas extra fun, because part of it is included in the bot's public API.Checklist
make qa(runsmake qualityandmake test)make qualitypasses.