Fix broken RST links in README and update outdated docs#794
Open
veeceey wants to merge 2 commits intoaio-libs:masterfrom
Open
Fix broken RST links in README and update outdated docs#794veeceey wants to merge 2 commits intoaio-libs:masterfrom
veeceey wants to merge 2 commits intoaio-libs:masterfrom
Conversation
- Fix malformed RST hyperlinks for "Signals" and "Web Server Advanced" in README.rst (missing closing backtick-underscores) - Add missing `await` in docs code example for `signal.send()` - Update Python version requirement from 3.8 to 3.9 in docs (3.8 was dropped in v1.3.2) - Update frozenlist version requirement from 1.0.0 to 1.1.0 in docs to match setup.cfg Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #794 +/- ##
=======================================
Coverage 99.34% 99.34%
=======================================
Files 2 2
Lines 153 153
Branches 6 6
=======================================
Hits 152 152
Misses 1 1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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
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.
What do these changes do?
Fix several documentation issues across README.rst and docs/index.rst:
README.rst: Fix two malformed RST hyperlinks for "Signals" and "Web Server Advanced" -- both were missing the closing
>`_syntax, causing them to render as broken text on PyPI and GitHub instead of proper clickable links.docs/index.rst: Add missing
awaitkeyword in the type-checker code example.Signal.send()is an async method (the docs even mark it with:async:), but the example showedsignal.send(42, "foo")instead ofawait signal.send(42, "foo").docs/index.rst: Update Python version requirement from 3.8 to 3.9 in two places. Python 3.8 support was dropped in v1.3.2, and
setup.cfgalready specifiespython_requires = >=3.9.docs/index.rst: Update frozenlist dependency version from
>= 1.0.0to>= 1.1.0to match whatsetup.cfgactually declares.Are there changes in behavior for the user?
No behavior changes. Documentation-only fixes.
Related issue number
None -- found by code inspection.
Checklist
CONTRIBUTORS.txtCHANGESfolder