Skip to content

Docs: Update validation utility comments and docstrings #5958

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 of 2 tasks
leandrodamascena opened this issue Jan 30, 2025 · 2 comments · Fixed by #5972
Closed
1 of 2 tasks

Docs: Update validation utility comments and docstrings #5958

leandrodamascena opened this issue Jan 30, 2025 · 2 comments · Fixed by #5972
Assignees
@leandrodamascena
Labels
documentation Improvements or additions to documentation internal Maintenance changes validator Validation (JSON Schema) utility
Milestone
Replace pdoc3 wit...

Comments

@leandrodamascena
Copy link
Contributor

Why is this needed?

Update validation utility comments and docstrings to add support for mkdocstrings.

Which area does this relate to?

Automation

Solution

No response

Acknowledgment
@leandrodamascena leandrodamascena added documentation Improvements or additions to documentation internal Maintenance changes labels Jan 30, 2025
@leandrodamascena leandrodamascena self-assigned this Jan 30, 2025
@leandrodamascena leandrodamascena moved this from Triage to Working on it in Powertools for AWS Lambda (Python) Jan 31, 2025
@leandrodamascena leandrodamascena mentioned this issue Jan 31, 2025
Merged
7 tasks
@leandrodamascena leandrodamascena linked a pull request Jan 31, 2025 that will close this issue
docs(api): migrating the validation utility to mkdocstrings #5972
Merged
7 tasks
@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in Powertools for AWS Lambda (Python) Jan 31, 2025
@github-actions GitHub Actions
Copy link
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments 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 Fix or implementation already in dev waiting to be released label Jan 31, 2025
@leandrodamascena leandrodamascena changed the title Maintenance: Update validation utility comments and docstrings Docs: Update validation utility comments and docstrings Feb 2, 2025
@leandrodamascena leandrodamascena added the validator Validation (JSON Schema) utility label Feb 2, 2025
@dreamorosi dreamorosi mentioned this issue Feb 3, 2025
Closed
@github-actions GitHub Actions
Copy link
Contributor

This is now released under 3.6.0 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Feb 11, 2025
@leandrodamascena leandrodamascena moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leandrodamascena leandrodamascena

Labels
documentation Improvements or additions to documentation internal Maintenance changes validator Validation (JSON Schema) utility
Projects
Powertools for AWS Lambda (Python)
Status: Shipped
Milestone
Replace pdoc3 with mkdocstrings
Development

Successfully merging a pull request may close this issue.

docs(api): migrating the validation utility to mkdocstrings aws-powertools/powertools-lambda-python
1 participant
@leandrodamascena