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

Tidy up toctree #7441

Merged
merged 8 commits into from
Jul 29, 2023
Merged

Tidy up toctree #7441

merged 8 commits into from
Jul 29, 2023

Conversation

Dreamsorcerer
Copy link
Member

Attempt to tidy up the toctree

@Dreamsorcerer Dreamsorcerer added bot:chronographer:skip This PR does not need to include a change note backport-3.9 labels Jul 27, 2023
@Dreamsorcerer
Copy link
Member Author

Dreamsorcerer commented Jul 28, 2023

That's an improvement. But, I don't know how to make a class be a top-level item, instead of a sublevel. For example, 'Response object' may be a redundant heading, but if I just remove it, then ClientResponse will appear under the 'Connectors' header when it needs to be 1 level higher.
https://aiohttp--7441.org.readthedocs.build/en/7441/client.html#aiohttp-client

@aio-libs aio-libs deleted a comment from codecov bot Jul 28, 2023
@aio-libs aio-libs deleted a comment from codecov bot Jul 28, 2023
@codecov
Copy link

codecov bot commented Jul 29, 2023

Codecov Report

Merging #7441 (689e0a3) into master (c6217be) will not change coverage.
Report is 4 commits behind head on master.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #7441   +/-   ##
=======================================
  Coverage   97.27%   97.27%           
=======================================
  Files         106      106           
  Lines       31441    31441           
  Branches     3565     3565           
=======================================
  Hits        30585    30585           
  Misses        652      652           
  Partials      204      204           
Flag Coverage Δ
CI-GHA 97.22% <ø> (ø)
OS-Linux 96.89% <ø> (ø)
OS-Windows 95.34% <ø> (ø)
OS-macOS 96.57% <ø> (ø)
Py-3.10.11 95.27% <ø> (ø)
Py-3.10.12 96.78% <ø> (ø)
Py-3.11.4 96.51% <ø> (ø)
Py-3.8.10 95.24% <ø> (ø)
Py-3.8.17 96.71% <ø> (ø)
Py-3.9.13 95.23% <ø> (ø)
Py-3.9.17 96.74% <ø> (ø)
Py-pypy7.3.11 96.31% <ø> (-0.01%) ⬇️
VM-macos 96.57% <ø> (ø)
VM-ubuntu 96.89% <ø> (ø)
VM-windows 95.34% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Dreamsorcerer Dreamsorcerer marked this pull request as ready for review July 29, 2023 13:24
@Dreamsorcerer Dreamsorcerer merged commit 36bc687 into master Jul 29, 2023
28 of 33 checks passed
@Dreamsorcerer Dreamsorcerer deleted the toctree branch July 29, 2023 16:04
@patchback
Copy link
Contributor

patchback bot commented Jul 29, 2023

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

❌ Failed to cleanly apply 36bc687 on top of patchback/backports/3.9/36bc68768bcef4ab0d95d0e8ba0047565ebc6e09/pr-7441

Backporting merged PR #7441 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 remote add 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.9/36bc68768bcef4ab0d95d0e8ba0047565ebc6e09/pr-7441 upstream/3.9
  4. Now, cherry-pick PR Tidy up toctree #7441 contents into that branch:
    $ git cherry-pick -x 36bc68768bcef4ab0d95d0e8ba0047565ebc6e09
    If it'll yell at you with something like fatal: Commit 36bc68768bcef4ab0d95d0e8ba0047565ebc6e09 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 36bc68768bcef4ab0d95d0e8ba0047565ebc6e09
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Tidy up toctree #7441 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.9/36bc68768bcef4ab0d95d0e8ba0047565ebc6e09/pr-7441
  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.

Dreamsorcerer added a commit that referenced this pull request Jul 29, 2023
Attempt to tidy up the toctree

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 36bc687)
Dreamsorcerer added a commit that referenced this pull request Jul 29, 2023
Attempt to tidy up the toctree

---------

Co-authored-by: pre-commit-ci[bot]
<66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 36bc687)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:skip This PR does not need to include a change note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant