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

5518 fix references in the abc.rst doc #5591

Closed
wants to merge 4 commits into from
Closed

5518 fix references in the abc.rst doc #5591

wants to merge 4 commits into from

Conversation

l1storez
Copy link
Contributor

@l1storez l1storez commented Apr 5, 2021

What do these changes do?

This change corrects multiple unrendered intersphinx class reference in the abc.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."

@l1storez l1storez changed the title 5518 fix refs in abc 5518 fix refs in abc.rst doc Apr 5, 2021
@l1storez l1storez changed the title 5518 fix refs in abc.rst doc 5518 fix references in the abc.rst doc Apr 5, 2021
@l1storez
Copy link
Contributor Author

l1storez commented Apr 6, 2021

I close the request because I lost access to the branch

@l1storez l1storez closed this Apr 6, 2021
@webknjaz
Copy link
Member

webknjaz commented Apr 6, 2021

@l1storez I suppose you merely forgot to rebase this branch on top of the upstream master.

:class:`AbstractRouter` has the only mandatory method:
:meth:`AbstractRouter.resolve` coroutine. It must return an
:class:`AbstractMatchInfo` instance.
:class:`aiohttp.abc.aiohttp.abc.AbstractRouter` has the only mandatory method:
Copy link
Member

Choose a reason for hiding this comment

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

these lines contain duplicate text

Copy link
Contributor Author

Choose a reason for hiding this comment

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

:py:class:aiohttp.abc.aiohttp.abc.AbstractRouter from https://webknjaz.github.io/intersphinx-untangled/docs.aiohttp.org/

Copy link
Member

Choose a reason for hiding this comment

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

Oh, wow. Sounds like there's some bug in how those docs are linked. Okay, leave it be.

@l1storez
Copy link
Contributor Author

l1storez commented Apr 6, 2021

I did rebase but I had history problems and "CI/ Linter error". Also, I lost access to the branch after checkout on the master. Because my "origin" was "my fork"

@webknjaz
Copy link
Member

New PR: #5610

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