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/whats_new_1_1.rst #5741

Merged
merged 2 commits 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 `whats_new_1_1.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
Copy link
Contributor Author

Is that fix right?
And where the mistake in ref :class:aiohttp.web.Request.url_for(name, **kwargs)? https://github.com/aio-libs/aiohttp/blame/d759a517dc876b546307460de01dbc71fce77845/docs/whats_new_1_1.rst#L35

@l1storez l1storez changed the title Fix broken references inwhats_new_1_1 Fix broken references in whats_new_1_1.rst May 28, 2021
@codecov
Copy link

codecov bot commented May 28, 2021

Codecov Report

Merging #5741 (24a80e2) into master (034d847) will not change coverage.
The diff coverage is n/a.

❗ Current head 24a80e2 differs from pull request most recent head 4daeb2c. Consider uploading reports for the commit 4daeb2c to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5741   +/-   ##
=======================================
  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 034d847...4daeb2c. Read the comment docs.

@l1storez l1storez changed the title Fix broken references in whats_new_1_1.rst Fix broken references in docs/whats_new_1_1.rst May 28, 2021
@webknjaz
Copy link
Member

And where the mistake in ref :class:aiohttp.web.Request.url_for(name, **kwargs)? d759a51/docs/whats_new_1_1.rst#L35 (blame)

The syntax is invalid, it shouldn't contain (name, **kwargs).

docs/whats_new_1_1.rst Outdated Show resolved Hide resolved
@webknjaz webknjaz merged commit e6baf3d 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/e6baf3d4d235d70bd4547791426f8ab80b3c9b68/pr-5741

Backported as #5770

🤖 @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
* Fix broken refs

* Drop an unnecessary colon

Co-authored-by: Sviatoslav Sydorenko <[email protected]>
(cherry picked from commit e6baf3d)
webknjaz pushed a commit that referenced this pull request Jun 6, 2021
…s_new_1_1.rst` (#5770)

* Fix broken refs

* Drop an unnecessary colon

Co-authored-by: Sviatoslav Sydorenko <[email protected]>
(cherry picked from commit e6baf3d)

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