Skip to content

Added miscellaneous category to documentation #1358

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

falcolnic
Copy link

@falcolnic falcolnic commented May 15, 2025

Description of Change

Added misc category to docs, because it lacks of other clients initialization.

Assumptions

None

Checklist for All Submissions

  • I have added change info to CHANGES.rst
  • 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

@jakob-keller jakob-keller added the documentation Improvements or additions to documentation label May 15, 2025
Copy link

codecov bot commented May 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.52%. Comparing base (cafe180) to head (ce13de2).
Report is 14 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1358      +/-   ##
==========================================
- Coverage   91.03%   90.52%   -0.51%     
==========================================
  Files          64       67       +3     
  Lines        6745     7302     +557     
==========================================
+ Hits         6140     6610     +470     
- Misses        605      692      +87     
Flag Coverage Δ
no-httpx 89.01% <ø> (?)
os-ubuntu-24.04 90.52% <ø> (?)
os-ubuntu-24.04-arm 90.24% <ø> (?)
python-3.10 90.23% <ø> (?)
python-3.11 90.23% <ø> (?)
python-3.12 90.23% <ø> (?)
python-3.13 90.50% <ø> (?)
python-3.9 90.22% <ø> (?)
unittests 90.52% <ø> (-0.51%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Collaborator

@jakob-keller jakob-keller left a comment

Choose a reason for hiding this comment

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

Thanks for using aiobotocore and taking the time to contribute an example!

Copy link
Collaborator

@jakob-keller jakob-keller left a comment

Choose a reason for hiding this comment

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

Thanks again! Besides the following comments, please ensure your commits are verified.

@@ -0,0 +1,11 @@
Cognito Identity Provider
Copy link
Collaborator

Choose a reason for hiding this comment

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

The heading should be descriptive of the example - to play nicely with the table of contents. In this case: Forgot Password

@@ -35,3 +35,10 @@ DynamoDB

examples/dynamo_db/insertions
examples/dynamo_db/tables

Cognito Identity Provider
--------
Copy link
Collaborator

Choose a reason for hiding this comment

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

To improve readability, the dashes should repeat for the entire width of the heading.

.. toctree::
:maxdepth: 2

examples/cognito_idp/forgot_password.rst
Copy link
Collaborator

Choose a reason for hiding this comment

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

To maintain the convention used for other links, please remove the .rst suffix.


We will demonstrate usage with the Cognito forgot password feature.

.. note::
Copy link
Collaborator

Choose a reason for hiding this comment

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

The note does not add much value and may be removed.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants