Docs: fix broken internal refs, fix broken intersphinx cross-refs to multidict, minor styling fixes #665
+31
−19
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
…fs to multidict, minor styling fixes Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
psf-chronographer
bot
added
the
bot:chronographer:provided
hoefling
changed the title
Codecov Report
@@ Coverage Diff @@
## master #665 +/- ##
=======================================
Coverage 99.72% 99.72%
=======================================
Files 4 4
Lines 717 717
Branches 162 162
=======================================
Hits 715 715
Misses 2 2
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
webknjaz
reviewed
Jan 16, 2022
webknjaz
reviewed
Jan 16, 2022
webknjaz
reviewed
Jan 16, 2022
There was a problem hiding this comment.
Looks like this patch could be coupled with adding strictness to the Sphinx setup. I like having default_role = 'any' and nitpicky = True in conf.py for this.
Also, adding -W --keep-going -n to the sphinx-build invocation is as helpful.
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
q0w
pushed a commit
to q0w/yarl
that referenced
this pull request
Mar 29, 2022
…multidict, minor styling fixes (aio-libs#665)
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?
This PR contains only documentation improvements, no code changes.
URL.human_repr()are fixed.intersphinxconfig, fixed broken URL tomultidictdocs.Are there changes in behavior for the user?
No
Related issue number
Didn't create one since the changes are trivial IMO
Checklist
Unit tests for the changes existnot needed, but an extra job in theciaction could watch over the docs and fail if new errors are introducedCHANGESfolder<issue_id>.<type>(e.g.588.bugfix)issue_idchange it to the pr id after creating the PR.feature: Signifying a new feature..bugfix: Signifying a bug fix..doc: Signifying a documentation improvement..removal: Signifying a deprecation or removal of public API..misc: A ticket has been closed, but it is not of interest to users.Fix issue with non-ascii contents in doctest text files.