docs: fix minor grammar issues in reference docs#12403
Closed
Bojun-Vvibe wants to merge 2 commits intoaio-libs:masterfrom
Closed
docs: fix minor grammar issues in reference docs#12403Bojun-Vvibe wants to merge 2 commits intoaio-libs:masterfrom
Bojun-Vvibe wants to merge 2 commits intoaio-libs:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12403 +/- ##
========================================
Coverage 98.92% 98.92%
========================================
Files 134 134
Lines 46616 46741 +125
Branches 2429 2429
========================================
+ Hits 46114 46239 +125
Misses 373 373
Partials 129 129
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Merging this PR will not alter performance
Comparing Footnotes
|
Member
|
@Bojun-Vvibe please use the PR template. |
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.
Repo: aio-libs/aiohttp (⭐ 15000)
Type: docs
Files changed: 4
Lines: +6/-3
What
Fixes three small grammatical issues in the documentation:
docs/streams.rst: "Get the exception occurred on data reading" → "Get the exception that occurred on data reading".docs/web_reference.rst: "Returns last occurred exception or None" → "Returns the last exception that occurred, or None".docs/client_advanced.rst: "resulting in a error like" → "resulting in an error like".Adds a CHANGES fragment (
CHANGES/12400.doc.rst) following the repo's towncrier conventions.Why
These are minor readability issues in public-facing Sphinx reference docs. They're the kind of polish that reviewers are happy to merge and add up over time. No code behavior changes.
Testing
Pure docs changes — no code paths touched. Visual review of the three hunks; the wording now reads as grammatical English. A full docs build would confirm no RST syntax errors, but the edits are minimal text substitutions in stable paragraphs.
Risk
Low — docs-only, three small text changes.