-
-
Notifications
You must be signed in to change notification settings - Fork 197
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
base: master
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this 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!
There was a problem hiding this 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 |
There was a problem hiding this comment.
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 | |||
-------- |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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:: |
There was a problem hiding this comment.
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.
Description of Change
Added misc category to docs, because it lacks of other clients initialization.
Assumptions
None
Checklist for All Submissions
Checklist when updating botocore and/or aiohttp versions