Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken references in docs/new_router.rst #5743

Merged
merged 1 commit into from
Jun 6, 2021

Conversation

l1storez
Copy link
Contributor

What do these changes do?

This change corrects multiple unrendered intersphinx class reference in the `new_router.rst` document.

Are there changes in behavior for the user?

No

Related issue number

#5518

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .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.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@codecov
Copy link

codecov bot commented May 28, 2021

Codecov Report

Merging #5743 (7538276) into master (0e5d743) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5743   +/-   ##
=======================================
  Coverage   97.17%   97.17%           
=======================================
  Files          41       41           
  Lines        8865     8865           
  Branches     1425     1425           
=======================================
  Hits         8615     8615           
  Misses        133      133           
  Partials      117      117           
Flag Coverage Δ
unit 97.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e5d743...7538276. Read the comment docs.

@@ -81,4 +81,4 @@ shortcut for::
return route

``app.router.register_route(...)`` is still supported, it creates
:class:`aiohttp.web.ResourceAdapter` for every call (but it's deprecated now).
:class:`aiohttp.web.StaticResource` for every call (but it's deprecated now).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a historic document pointing at something that doesn't exist anymore. So just remove the class role instead of pointing at a wrong thing.

Suggested change
:class:`aiohttp.web.StaticResource` for every call (but it's deprecated now).
``aiohttp.web.ResourceAdapter`` for every call (but it's deprecated now).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I decided that ResourceAdaptep was replaced by StaticResource, but okay

@webknjaz webknjaz merged commit e78ea41 into aio-libs:master Jun 6, 2021
@patchback
Copy link
Contributor

patchback bot commented Jun 6, 2021

Backport to 3.8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.8/e78ea414509cde80ba5a4c6e9abcd90c62ea029d/pr-5743

Backported as #5768

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jun 6, 2021
webknjaz pushed a commit that referenced this pull request Jun 6, 2021
…router.rst` (#5768)

(cherry picked from commit e78ea41)

Co-authored-by: Olexiy Pohorely <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants