Skip to content

api: docstring updates #3352

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.

Sign up for GitHub

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
efiop merged 2 commits into from
Feb 23, 2020
Merged

api: docstring updates #3352

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d6b223
api: update to latest definitions to match iterative/dvc.org/pull/908
jorgeorpinel Feb 18, 2020
6b14cef
Update dvc/api.py
efiop Feb 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions dvc/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ def __init__(self, url):


def get_url(path, repo=None, rev=None, remote=None):
"""
Returns the full URL to the data artifact specified by its `path` in a
`repo`.
NOTE: There is no guarantee that the file actually exists in that location.
"""Returns URL to the storage location of a data artifact tracked
by DVC, specified by its path in a repo.

NOTE: There's no guarantee that the file actually exists in that location.
"""
with _make_repo(repo, rev=rev) as _repo:
_require_dvc(_repo)
Expand All @@ -31,7 +31,7 @@ def get_url(path, repo=None, rev=None, remote=None):


def open(path, repo=None, rev=None, remote=None, mode="r", encoding=None):
"""Context manager to open a file artifact as a file object."""
"""Context manager to open a tracked file as a file object."""
args = (path,)
kwargs = {
"repo": repo,
Expand Down Expand Up @@ -63,7 +63,7 @@ def _open(path, repo=None, rev=None, remote=None, mode="r", encoding=None):


def read(path, repo=None, rev=None, remote=None, mode="r", encoding=None):
"""Returns the contents of a file artifact."""
"""Returns the contents of a tracked file."""
with open(
path, repo=repo, rev=rev, remote=remote, mode=mode, encoding=encoding
) as fd:
Expand Down