Docstrings cleanup#24
Merged
Merged
Conversation
In 0.2.0 we removed the executor pattern, but the executor attribute was never cleaned up.
- delete_items: tuple shape was documented as (scheduled_ts, key, item) but the actual tuple is (scheduled_ts, item) - cancel_event: Returns section claimed (int) but actual return type is list[tuple[float, CalendarEvent]] - clear: description said 'The number of cancelled events' instead of 'List of cancelled events'
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
get_nowait() is inherited from asyncio.Queue and pops the next heap entry immediately without checking whether its timestamp has been reached. Add an explicit override with a docstring that makes this behavior visible via the docstring in IDEs' intellisense.
claudious96
force-pushed
the
fix/docstrings-cleanup
branch
from
2184420 to
bb11e59
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Remove leftovers from the transition from 0.1.0 to 0.2.0 and fix broken or missing docstrings.