chore: add freshly written docstrings and async examples - #1848
Merged
Merged
Conversation
|
Thanks for contributing! A quick note: this project is in the process of moving from LGPL-2.1 to Apache 2.0, see #1835. By continuing with this pull request you are okay with your contribution, and your previous contributions to this repository, being offered under Apache 2.0. If that does not work for you, no hard feelings; reply with the exact phrase |
bdraco
force-pushed
the
restore_fresh_docstrings
branch
from
August 29, 2026 19:36
cff5f32 to
0d6f3c1
Compare
bdraco
marked this pull request as ready for review
August 29, 2026 19:37
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1848 +/- ##
=======================================
Coverage 99.87% 99.87%
=======================================
Files 33 33
Lines 3882 3882
Branches 567 567
=======================================
Hits 3877 3877
Misses 3 3
Partials 2 2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Summary
Follow up to #1847 for #1835. Adds freshly written docstrings for every public member that lost its rendered API documentation in the derivative prose removal, terse one liners for the internal helpers that earn them, and two brand new async example scripts replacing the deleted ones.
Details
asyncio.create_taskandasyncio.Eventinstead of the legacyensure_futureand sleep loopsTest plan
--helpand pass ruffzeroconforzeroconf.asynciolost documentation relative to master except pre existing gaps