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.

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

docs(api): migrating the idempotency utility to mkdocstrings #6007

Merged
merged 1 commit into from
Feb 3, 2025

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #5986

Summary

Changes

Update Idempotency 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 as a code owner February 3, 2025 16:59
@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/M Denotes a PR that changes 30-99 lines, ignoring generated files. label 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
Copy link

sonarqubecloud bot commented Feb 3, 2025

@leandrodamascena leandrodamascena merged commit af13807 into develop Feb 3, 2025
16 checks passed
@leandrodamascena leandrodamascena deleted the mkdocstrings/idempotency branch February 3, 2025 17:01
Copy link

codecov bot commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.24%. Comparing base (9043ee2) to head (4e01506).
Report is 1 commits behind head on develop.

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

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

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Update idempotency utility comments and docstrings
2 participants