api: docstring updates (2) #3426
Merged
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
1 task
skshetry
reviewed
Mar 2, 2020
skshetry
reviewed
Mar 2, 2020
Suor
suggested changes
Mar 2, 2020
Suor
suggested changes
Mar 5, 2020
There was a problem hiding this comment.
Only .open() left, wrote a comment. Otherwise it's ready to merge, thanks @jorgeorpinel.
Suor
approved these changes
Mar 9, 2020
skshetry
approved these changes
Mar 10, 2020
efiop
added a commit
that referenced
this pull request
Oct 12, 2020
* api: update to latest definitions to match iterative/dvc.org/pull/908 * Update dvc/api.py * metrics show: update -h output to match docs per iterative/dvc.org@2c34521 * api: update docstrings to match iterative/dvc.org/pull/908 * api: refactor DVC repo check in get_url, and document it * dvc: cosmetic edits as I explored exceptions that api functions may raise * api: copy default info to read() docstring from open() per #3426 (review) * api: improve open() docstring for clarity and add example per #3426 (review) * api: remove unnecessary info from get_url docstring per #3426 (comment) * api: produces->generated in open() docstring * api: simplify open docstring per #3426 (comment) * term: "metrics" plural in output messages iterative/dvc.org#1848 (review) * typo Co-authored-by: Ruslan Kuprieiev <[email protected]>
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.
Continues #3352
to match iterative/dvc.org/pull/908
Closes #3092
❗ Have you followed the guidelines in the Contributing to DVC list?
📖 Check this box if this PR does not require documentation updates, or if it does and you have created a separate PR in dvc.org with such updates (or at least opened an issue about it in that repo). Please link below to your PR (or issue) in the dvc.org repo.
❌ Have you checked DeepSource, CodeClimate, and other sanity checks below? We consider their findings recommendatory and don't expect everything to be addressed. Please review them carefully and fix those that actually improve code or fix bugs.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏