tools.time: versionadded annotations for great justice #2379
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
Was working on something in sopel-github and got annoyed that I had to check `git blame` to verify that the functions I wanted to use would be available in that plugin's minimum required Sopel version. If people are nice to me, I might go through the rest of `sopel.tools` and add any missing version annotations in its other submodules, too.
A missing blank line caught my eye, on the way to fixing some wonky English that got missed during code review in the pre-7.x days.
dgw
added
Documentation
Housekeeping
Exirel
approved these changes
Nov 21, 2022
Contributor
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
I like this change. I think we could have a spec for our docstrings that says "add the versionadded/changed at the bottom but before ..note and such". This is more or less what we did so far and I think it works for us.
Member
Author
Seems like that's what the Python docs do, in general, too. Which is probably why I used that style. 😁 |
4 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.
Description
Was working on something in sopel-github and got annoyed that I had to check
git blameto verify that the functions I wanted to use would be available in that plugin's minimum required Sopel version.willie.tools.timecame into existence in the 5.3 release, so I used that as the module'sversionadded, and treated the namespace change fromwillietosopelas aversionchangedevent.If people are nice to me (read: this gets reviewed in something less than a month 😝), I might go through the rest of
sopel.toolsand add any missing version annotations in its other submodules, too. This is the sort of thing I'm always on the lookout for when working on other stuff, because if the documentation annoys me (who's been around the project for almost a decade), it will almost certainly annoy noobs.Relevant preview link
I touched only
sopel/tools/time.py, so of the whole preview deploy available from Netlify, only https://deploy-preview-2379--sopel-unstable-docs.netlify.app/package/tools/time.html is relevant for review.Checklist
make qa(runsmake qualityandmake test)