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 the link to MultiDict in client_quickstart.rst #5517

Merged
merged 1 commit into from Mar 6, 2021

Conversation

webknjaz
Copy link
Member

@webknjaz webknjaz commented Mar 6, 2021

What do these changes do?

This change corrects an unrendered intersphinx class reference in the client_quickstart.rst document.

Are there changes in behavior for the user?

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."

@webknjaz webknjaz added enhancement documentation Improvements or additions to documentation labels Mar 6, 2021
@webknjaz webknjaz self-assigned this Mar 6, 2021
@webknjaz webknjaz requested a review from asvetlov as a code owner March 6, 2021 19:15
@codecov
Copy link

codecov bot commented Mar 6, 2021

Codecov Report

Merging #5517 (4945527) into master (25dfe50) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5517   +/-   ##
=======================================
  Coverage   97.17%   97.17%           
=======================================
  Files          41       41           
  Lines        8854     8854           
  Branches     1424     1424           
=======================================
  Hits         8604     8604           
  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 25dfe50...4945527. Read the comment docs.

@webknjaz webknjaz merged commit 13fd83e into master Mar 6, 2021
@webknjaz webknjaz deleted the docs/multidict-ref-client-quickstart branch March 6, 2021 19:44
@webknjaz webknjaz restored the docs/multidict-ref-client-quickstart branch March 6, 2021 19:44
@webknjaz webknjaz deleted the docs/multidict-ref-client-quickstart branch March 6, 2021 19:44
@webknjaz webknjaz restored the docs/multidict-ref-client-quickstart branch March 6, 2021 19:44
webknjaz added a commit that referenced this pull request Mar 6, 2021
@webknjaz webknjaz deleted the docs/multidict-ref-client-quickstart branch March 6, 2021 19:46
webknjaz added a commit that referenced this pull request Mar 6, 2021
@patchback

This comment has been minimized.

@patchback

This comment has been minimized.

@patchback
Copy link
Contributor

patchback bot commented Apr 17, 2021

Backport to 3.8: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 13fd83e on top of patchback/backports/3.8/13fd83ee73aa584174ebe3b8c4e19e4c5fcddfd7/pr-5517

Backporting merged PR #5517 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git add remote upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/3.8/13fd83ee73aa584174ebe3b8c4e19e4c5fcddfd7/pr-5517 upstream/3.8
  4. Now, cherry-pick PR Fix the link to MultiDict in client_quickstart.rst #5517 contents into that branch:
    $ git cherry-pick -x 13fd83ee73aa584174ebe3b8c4e19e4c5fcddfd7
    If it'll yell at you with something like fatal: Commit 13fd83ee73aa584174ebe3b8c4e19e4c5fcddfd7 is a merge but no -m option was given., add -m 1 as follows intead:
    $ git cherry-pick -m1 -x 13fd83ee73aa584174ebe3b8c4e19e4c5fcddfd7
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix the link to MultiDict in client_quickstart.rst #5517 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.8/13fd83ee73aa584174ebe3b8c4e19e4c5fcddfd7/pr-5517
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

commonism pushed a commit to commonism/aiohttp that referenced this pull request Apr 27, 2021
commonism pushed a commit to commonism/aiohttp that referenced this pull request Apr 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant