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

Docs: fix broken internal refs, fix broken intersphinx cross-refs to multidict, minor styling fixes #665

Merged
merged 11 commits into from Jan 23, 2022

Conversation

hoefling
Copy link
Contributor

@hoefling hoefling commented Jan 16, 2022

What do these changes do?

This PR contains only documentation improvements, no code changes.

  1. Broken internal refs to e.g. URL.human_repr() are fixed.
  2. Broken crossrefs are fixed: dropped duplicate intersphinx config, fixed broken URL to multidict docs.
  3. Markdown styling that hasn't the same meaning in ReST fixed.

Are there changes in behavior for the user?

No

Related issue number

Didn't create one since the changes are trivial IMO

Checklist

  • I think the code is well written
  • Unit tests for the changes exist not needed, but an extra job in the ci action could watch over the docs and fail if new errors are introduced
  • Documentation reflects the changes
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> (e.g. 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.

…fs to multidict, minor styling fixes

Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jan 16, 2022
@hoefling
Copy link
Contributor Author

Docs built from this PR

@hoefling hoefling changed the title chore(doc): fix broken internal refs, fix broken intersphinx cross-refs to multidict, minor styling fixes Docs: fix broken internal refs, fix broken intersphinx cross-refs to multidict, minor styling fixes Jan 16, 2022
@codecov
Copy link

codecov bot commented Jan 16, 2022

Codecov Report

Merging #665 (b5a0ab2) into master (2830a3d) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #665   +/-   ##
=======================================
  Coverage   99.72%   99.72%           
=======================================
  Files           4        4           
  Lines         717      717           
  Branches      162      162           
=======================================
  Hits          715      715           
  Misses          2        2           
Flag Coverage Δ
unit 99.58% <ø> (ø)

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 2830a3d...b5a0ab2. Read the comment docs.

CHANGES/665.doc Outdated Show resolved Hide resolved
CHANGES/665.doc Outdated Show resolved Hide resolved
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

Looks like this patch could be coupled with adding strictness to the Sphinx setup. I like having default_role = 'any' and nitpicky = True in conf.py for this.
Also, adding -W --keep-going -n to the sphinx-build invocation is as helpful.

Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Hoefling <oleg.hoefling@gmail.com>
Copy link
Member

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@asvetlov asvetlov merged commit b8d15e3 into aio-libs:master Jan 23, 2022
q0w pushed a commit to q0w/yarl that referenced this pull request Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants