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.

Sign up for GitHub

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

Jump to bottom

Docs: create API docs #1104

Closed
ijemmy opened this issue Sep 29, 2022 · 1 comment · Fixed by #1485
Closed

Docs: create API docs #1104

ijemmy opened this issue Sep 29, 2022 · 1 comment · Fixed by #1485
Assignees
@am29d
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation idempotency This item relates to the Idempotency Utility
Milestone
Idempotency - Bet...

Comments

@ijemmy
Copy link
Contributor

ijemmy commented Sep 29, 2022

Description of the improvement

Summary of the proposal
As a part of our documentation we have a section that focuses on the APIs available. The new utility should feature docstrings that will then populate the corresponding pages of this documentation.

How, where did you look for information
This unit of work tracks the activities related to having the API docs for the new utility. On an high level, these are:

  • Create docstrings for each class / method / function
  • Review content accuracy & wording
  • Review visually the docs locally

Missing or unclear documentation
https://awslabs.github.io/aws-lambda-powertools-typescript/latest/api/modules/_aws_lambda_powertools_parameters.html

Improvement
N/A

Related existing documentation

[N/A](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/api/

Related issues, RFCs

#447
@ijemmy ijemmy added documentation Improvements or additions to documentation on-hold This item is on-hold and will be revisited in the future idempotency This item relates to the Idempotency Utility labels Sep 29, 2022
@saragerion saragerion added this to the Idempotency milestone Sep 29, 2022
@dreamorosi dreamorosi moved this from On hold to Backlog in AWS Lambda Powertools for TypeScript Nov 13, 2022
@dreamorosi dreamorosi changed the title Documentation (idempotency): create API docs Docs: create API docs Nov 14, 2022
This was referenced Feb 17, 2023
Closed
Closed
Closed
Closed
Closed
@am29d am29d self-assigned this May 16, 2023
@dreamorosi dreamorosi added confirmed The scope is clear, ready for implementation and removed on-hold This item is on-hold and will be revisited in the future labels May 19, 2023
@dreamorosi dreamorosi moved this from Backlog to Working on it in AWS Lambda Powertools for TypeScript May 19, 2023
@am29d am29d mentioned this issue Jun 7, 2023
Merged
9 tasks
@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Jun 12, 2023
@dreamorosi dreamorosi moved this from Working on it to Shipped in AWS Lambda Powertools for TypeScript Jun 12, 2023
@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Jun 12, 2023
@dreamorosi dreamorosi linked a pull request Jun 12, 2023 that will close this issue
docs(idempotency): API docs for idempotency #1485
Merged
9 tasks
@github-project-automation github-project-automation bot moved this from Shipped to Coming soon in AWS Lambda Powertools for TypeScript Jun 12, 2023
@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@am29d am29d

Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation idempotency This item relates to the Idempotency Utility
Projects
None yet
Milestone
Idempotency - Beta release
Development

Successfully merging a pull request may close this issue.

docs(idempotency): API docs for idempotency
4 participants
@ijemmy @am29d @dreamorosi @saragerion