docs(Files): Add tip section to FilesAPI methods regarding "Data Modeling Files API"#2692
Open
haakonvt wants to merge 1 commit into
Open
docs(Files): Add tip section to FilesAPI methods regarding "Data Modeling Files API"#2692haakonvt wants to merge 1 commit into
haakonvt wants to merge 1 commit into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds tips to the docstrings of several file API methods, recommending the use of Data Modeling files API where appropriate. The reviewer notes that the custom 'Tip:' header is not standard for Google/Napoleon docstrings and will fail to render correctly in Sphinx, suggesting the use of the standard '.. tip::' directive instead.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2692 +/- ##
==========================================
- Coverage 93.68% 93.65% -0.04%
==========================================
Files 498 498
Lines 50391 50391
==========================================
- Hits 47209 47192 -17
- Misses 3182 3199 +17
🚀 New features to boost your workflow:
|
haakonvt
force-pushed
the
add-DM-tip-on-file-methods
branch
from
d3393f5 to
e401d14
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.