Skip to content

Docs: add testing your code section #1321

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
Closed
1 task done
dreamorosi opened this issue Feb 21, 2023 · 1 comment · Fixed by #1383
Closed
1 task done

Docs: add testing your code section #1321

dreamorosi opened this issue Feb 21, 2023 · 1 comment · Fixed by #1383
Assignees
@dreamorosi
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation parameters This item relates to the Parameters Utility
Milestone
Parameters - GA R...

Comments

@dreamorosi
Copy link
Contributor

What were you searching in the docs?

The current version of the Parameters docs doesn't include information on how to test code that uses the utility. This is an useful section for those customers who might want to use the utility in their production workflow.

Is this related to an existing documentation section?

This section is available in the documentation of Powertools for Python.

How can we improve?

We should provide a similar section that shows how to test code that uses the Parameters utility alongside Jest.

Got a suggestion in mind?

Check the unit tests of the utility and extract a simplified example.

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@dreamorosi dreamorosi converted this from a draft issue Feb 21, 2023
@dreamorosi dreamorosi assigned dreamorosi and unassigned dreamorosi Feb 21, 2023
@dreamorosi dreamorosi added documentation Improvements or additions to documentation parameters This item relates to the Parameters Utility confirmed The scope is clear, ready for implementation labels Feb 21, 2023
@dreamorosi dreamorosi added this to the Parameters - GA Release milestone Feb 21, 2023
@am29d am29d self-assigned this Mar 14, 2023
@dreamorosi dreamorosi assigned dreamorosi and unassigned am29d Mar 24, 2023
@dreamorosi dreamorosi moved this from Backlog to Working on it in AWS Lambda Powertools for TypeScript Mar 24, 2023
@dreamorosi dreamorosi mentioned this issue Mar 25, 2023
Merged
13 tasks
@dreamorosi dreamorosi linked a pull request Mar 25, 2023 that will close this issue
docs(parameters): add "testing your code" section #1383
Merged
13 tasks
@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in AWS Lambda Powertools for TypeScript Mar 25, 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.

@github-actions github-actions bot added the pending-release This item has been merged and will be released soon label Mar 25, 2023
@dreamorosi dreamorosi removed the confirmed The scope is clear, ready for implementation label Mar 27, 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 Apr 11, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in AWS Lambda Powertools for TypeScript Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dreamorosi dreamorosi

Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation parameters This item relates to the Parameters Utility
Projects
None yet
Milestone
Parameters - GA Release
Development

Successfully merging a pull request may close this issue.

docs(parameters): add "testing your code" section aws-powertools/powertools-lambda-typescript
2 participants
@am29d @dreamorosi