document dvcfs #8332
document dvcfs #8332
Conversation
| @@ -238,7 +272,8 @@ def _open( | |||
| dvc_path = _get_dvc_path(dvc_fs, subkey) | |||
| return dvc_fs.open(dvc_path, mode=mode) | |||
|
|
|||
| def isdvc(self, path, **kwargs): | |||
| def isdvc(self, path, **kwargs) -> bool: | |||
| """Is this entry dvc-tracked?""" | |||
There was a problem hiding this comment.
There is a bit of a question on whether isdvc even means anything and if it is that useful. We can keep it for now as is, but there is a chance it will change in the future and that's probably alright.
skshetry
force-pushed
the
document-dvcfs
branch
from
d782165 to
5f75588
Compare
dvc/fs/dvc.py
Outdated
| Defaults to the default branch in case of remote repositories. | ||
| In case of a local repository or if the repo is not a Git repo, | ||
| this option is ignored. |
There was a problem hiding this comment.
| Defaults to the default branch in case of remote repositories. | |
| In case of a local repository or if the repo is not a Git repo, | |
| this option is ignored. | |
| Defaults to the default branch in case of Git repositories. | |
| In case the repo is not a Git repo this option is ignored. |
@skshetry As far as I have tried, rev also works for local Git repositories, right?
|
Fixes #8336 |
|
Is there a way to auto generate docs for only dvcfs? |
There was a problem hiding this comment.
Pending local rev change in https://github.com/iterative/dvc/pull/8332/files/5f7558844c234a222ad28375a1cb3a468cf6b567#r975609286
skshetry
force-pushed
the
document-dvcfs
branch
from
5f75588 to
f64bb46
Compare
I am trying to avoid duplicating docstrings (AFAIK you cannot extend docstrings just for |
Only documenting
DvcFileSystem.__init__andisdvcfor now, because others inherit the docstrings from superclass.