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

Re-organise docs examples #810

Merged
merged 2 commits into from
Dec 16, 2021
Merged

Re-organise docs examples #810

merged 2 commits into from
Dec 16, 2021

Conversation

skonik
Copy link
Contributor

@skonik skonik commented May 21, 2020

Description of Change

Documentation examples are now grouped into subsections per example topic.
result

Assumptions

Checklist for All Submissions

  • I have added change info to CHANGES.rst
  • If this is resolving an issue (needed so future developers can determine if change is still necessary and under what conditions) (can be provided via link to issue with these details):
    • Detailed description of issue
    • Alternative methods considered (if any)
    • How issue is being resolved
    • How issue can be reproduced
  • If this is providing a new feature (can be provided via link to issue with these details):
    • Detailed description of new feature
    • Why needed
    • Alternatives methods considered (if any)

Checklist when updating botocore and/or aiohttp versions

  • I have read and followed CONTRIBUTING.rst
  • I have updated test_patches.py where/if appropriate (also check if no changes necessary)
  • I have ensured that the awscli/boto3 versions match the updated botocore version

@codecov
Copy link

codecov bot commented May 21, 2020

Codecov Report

Merging #810 (4de9936) into master (4d198ec) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #810   +/-   ##
=======================================
  Coverage   89.27%   89.27%           
=======================================
  Files          42       42           
  Lines        4576     4576           
=======================================
  Hits         4085     4085           
  Misses        491      491           
Flag Coverage Δ
unittests 89.27% <ø> (ø)

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 4d198ec...4de9936. Read the comment docs.

@terricain terricain self-requested a review May 21, 2020 18:02
@terricain
Copy link
Collaborator

Let me know when your finished and i'll look through it

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@thehesiod
Copy link
Collaborator

@terrycain is this ok to merge?

@terricain
Copy link
Collaborator

Yep looks fine, just a bit of re-organisation it seems

Copy link
Collaborator

@terricain terricain left a comment

Choose a reason for hiding this comment

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

Looks good, but you'll need to rebase the branch to take into account newer changes in master.

@skonik
Copy link
Contributor Author

skonik commented Dec 16, 2021

Sorry, completely forgot about this.
Yes, this is just a simple re-organisation

@skonik
Copy link
Contributor Author

skonik commented Dec 16, 2021

Let me fix some typos. In general currently we have this

aiobotocore-reorganize-docs.mov

@skonik skonik changed the title Grouping documentation examples into subsections Re-organize docs examples Dec 16, 2021
@skonik skonik changed the title Re-organize docs examples Re-organise docs examples Dec 16, 2021
@thehesiod thehesiod merged commit 0b71254 into aio-libs:master Dec 16, 2021
@thehesiod
Copy link
Collaborator

thanks!

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.

4 participants