Add exception docs#3490
Merged
Merged
Conversation
Indent the parameters for Response in the class documentation so that the link to it is generated.
Codecov Report
@@ Coverage Diff @@
## master #3490 +/- ##
==========================================
- Coverage 97.95% 97.93% -0.03%
==========================================
Files 44 44
Lines 8554 8554
Branches 1377 1377
==========================================
- Hits 8379 8377 -2
- Misses 71 72 +1
- Partials 104 105 +1
Continue to review full report at Codecov.
|
asvetlov
approved these changes
Jan 6, 2019
Member
|
Thanks! |
asvetlov
pushed a commit
that referenced
this pull request
Jan 6, 2019
* Fix aiohttp.web.Response docs. * Adjust json_response TOC level. * Add HTTPException class documentation. (cherry picked from commit 3a0c7bf) Co-authored-by: dave-shawley <[email protected]>
asvetlov
added a commit
that referenced
this pull request
Jan 6, 2019
* Fix aiohttp.web.Response docs. * Adjust json_response TOC level. * Add HTTPException class documentation. (cherry picked from commit 3a0c7bf) Co-authored-by: dave-shawley <[email protected]>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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?
A few simple documentation changes to enable linking to
aiohttp.web.Responseandaiohttp.web.HTTPExceptionusingsphinx.ext.intersphinx. Previously the class documentation forResponsewas not indented properly so a link was not generated in objects.inv. I added class documentation foraiohttp.web.HTTPExceptionthat refers to the existing exception documentation.Are there changes in behavior for the user?
Nope. No changes in behavior whatsoever.
Related issue number
Not that I am aware of.
Checklist
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.