Skip to content

docs(api): migrating the validation utility to mkdocstrings #5972

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
Jan 31, 2025

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #5958

Summary

Changes

Migrating the validation utility to 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 January 31, 2025 16:34
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jan 31, 2025
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 31, 2025
@leandrodamascena leandrodamascena self-assigned this Jan 31, 2025
@leandrodamascena leandrodamascena linked an issue Jan 31, 2025 that may be closed by this pull request
2 tasks
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.24%. Comparing base (963e24a) to head (1b8f7d2).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #5972   +/-   ##
========================================
  Coverage    96.24%   96.24%           
========================================
  Files          234      234           
  Lines        11013    11013           
  Branches       798      798           
========================================
  Hits         10599    10599           
  Misses         327      327           
  Partials        87       87           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leandrodamascena leandrodamascena merged commit 6971eb2 into develop Jan 31, 2025
18 checks passed
@leandrodamascena leandrodamascena deleted the mkdocstrings/validation branch January 31, 2025 18:57
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 validation utility comments and docstrings
2 participants