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

Hotfix references in docs #5721

Merged
merged 2 commits into from
May 19, 2021
Merged

Hotfix references in docs #5721

merged 2 commits into from
May 19, 2021

Conversation

l1storez
Copy link
Contributor

@l1storez l1storez commented May 17, 2021

What do these changes do?

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

Open to name change. PR fixes some losing warnings in docs

@codecov
Copy link

codecov bot commented May 17, 2021

Codecov Report

Merging #5721 (ceea612) into master (7a4cebb) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5721   +/-   ##
=======================================
  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 7a4cebb...ceea612. Read the comment docs.

@l1storez l1storez marked this pull request as ready for review May 19, 2021 21:14
@webknjaz webknjaz changed the title 5518 Hotfix references in docs Hotfix references in docs May 19, 2021
@webknjaz
Copy link
Member

It's best to actually fill out the PR template but I don't have energy to go through that now. Merging as is.

@webknjaz webknjaz merged commit 63eb6ff into aio-libs:master May 19, 2021
@patchback
Copy link
Contributor

patchback bot commented May 19, 2021

Backport to 3.8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.8/63eb6ff550b2ba9f13cf5248980a4958e14a1af7/pr-5721

Backported as #5724

🤖 @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 May 19, 2021
* removed the prefix from line 167

* Add reference to ignore

(cherry picked from commit 63eb6ff)
webknjaz pushed a commit that referenced this pull request May 19, 2021
* removed the prefix from line 167

* Add reference to ignore

(cherry picked from commit 63eb6ff)

Co-authored-by: Olexiy Pohorely <52452803+l1storez@users.noreply.github.com>
@l1storez
Copy link
Contributor Author

Update PR template

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