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

Maintenance: review API docs & README for Parameters #2378

Open
1 of 4 tasks
dreamorosi opened this issue Apr 16, 2024 · 0 comments
Open
1 of 4 tasks

Maintenance: review API docs & README for Parameters #2378

dreamorosi opened this issue Apr 16, 2024 · 0 comments
Labels
confirmed The scope is clear, ready for implementation documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) parameters This item relates to the Parameters Utility

Comments

@dreamorosi
Copy link
Contributor

dreamorosi commented Apr 16, 2024 •
edited

Summary

This issue is part of a larger group: #2381

As part of this task we should:

  • review that the README file for the package is relevant for customers and follow the structure described in the parent issue
  • review the API docs and apply the conventions described in the parent issue

Why is this needed?

So that customers finding the package on npm or using the API docs have the right level of details.

Which area does this relate to?

Other

Solution

No response

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.
@dreamorosi dreamorosi added documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) parameters This item relates to the Parameters Utility confirmed The scope is clear, ready for implementation labels Apr 16, 2024
@dreamorosi dreamorosi mentioned this issue Apr 16, 2024
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
confirmed The scope is clear, ready for implementation documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) parameters This item relates to the Parameters Utility
Projects
Powertools for AWS Lambda (TypeScript)
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dreamorosi