Fix broken reference in docs/web_exceptions.rst
#5751
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #5751 +/- ##
=======================================
Coverage 97.17% 97.17%
=======================================
Files 41 41
Lines 8865 8865
Branches 1425 1425
=======================================
Hits 8615 8615
Misses 133 133
Partials 117 117
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
webknjaz
reviewed
May 31, 2021
docs/web_exceptions.rst
Outdated
| @@ -479,13 +479,13 @@ HTTP exceptions for status code in range 400-499, e.g. ``raise web.HTTPNotFound( | |||
| :exc:`HTTPClientError`. | |||
|
|
|||
| :param link: A link to a resource with information for blocking reason, | |||
| :class:`str` or :class:`URL` | |||
| :class:`str` or :class:`yarl.URL` | |||
There was a problem hiding this comment.
Suggested change
| :class:`str` or :class:`yarl.URL` | |
| :class:`str` or :class:`~yarl.URL` |
webknjaz
reviewed
May 31, 2021
docs/web_exceptions.rst
Outdated
|
|
||
| For other parameters see :exc:`HTTPException` constructor. | ||
|
|
||
| .. attribute:: link | ||
|
|
||
| A :class:`URL` link to a resource with information for blocking reason, | ||
| A :class:`yarl.URL` link to a resource with information for blocking reason, |
There was a problem hiding this comment.
Suggested change
| A :class:`yarl.URL` link to a resource with information for blocking reason, | |
| A :class:`~yarl.URL` link to a resource with information for blocking reason, |
l1storez
force-pushed
the
5518-fix-web-exc
branch
from
491de6c
to
6cf0bcb
Compare
|
fixed |
webknjaz
approved these changes
Jun 6, 2021
This comment has been minimized.
This comment has been minimized.
|
Backport to v3.8 is unnecessary because the patched doc didn't exist back then. |
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 change corrects multiple unrendered intersphinx class reference in the `web_exceptions.rst` document.Are there changes in behavior for the user?
NoRelated issue number
#5518Checklist
CONTRIBUTORS.txtCHANGESfolder<issue_id>.<type>for example (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.