Skip to content

docs(api): migrating the parameters utility to mkdocstrings #6005

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

Merged
merged 1 commit into from
Feb 3, 2025

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #5984

Summary

Changes

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

User experience

image

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@leandrodamascena leandrodamascena requested a review from a team February 3, 2025 16:20
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Feb 3, 2025
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 3, 2025
Copy link

sonarqubecloud bot commented Feb 3, 2025

@leandrodamascena leandrodamascena linked an issue Feb 3, 2025 that may be closed by this pull request
1 task
@leandrodamascena leandrodamascena self-assigned this Feb 3, 2025
@leandrodamascena leandrodamascena merged commit c6ddf6c into develop Feb 3, 2025
11 checks passed
@leandrodamascena leandrodamascena deleted the mkdocstrings/parameters branch February 3, 2025 16:21
sinofseven pushed a commit to sinofseven/powertools-lambda-python-my-extend that referenced this pull request Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Update parameters utility comments and docstrings
2 participants