[DOCS] ADR around public API docstrings #10798
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for niobium-lead-7998 canceled.
|
cdkini
commented
Dec 19, 2024
|
|
||
| ## Status | ||
|
|
||
| Accepted |
There was a problem hiding this comment.
Perhaps presumptuous of me 😬
cdkini
commented
Dec 19, 2024
Comment on lines
137
to
138
| public_api_introspector.add(func) | ||
| existing_docstring = func.__doc__ if func.__doc__ else "" |
There was a problem hiding this comment.
Minor change in ordering - let's fail fast if we don't have the docstring before adding to the introspector. Marginal performance gains doesn't really matter tbh
…_expectations into m/_/public_api_docstrings_adr
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## develop #10798 +/- ##
========================================
Coverage 80.70% 80.70%
========================================
Files 464 464
Lines 40373 40373
========================================
Hits 32582 32582
Misses 7791 7791
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Let's be a bit more stringent with our requirements when decorating with
@public_apiinvoke lint(usesruff format+ruff check)For more information about contributing, visit our community resources.
After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!