Skip to content

Commit

Permalink
DOC: add examples for unlock
Browse files Browse the repository at this point in the history
  • Loading branch information
adswa committed Jan 27, 2020
1 parent 45f2f47 commit afbfd32
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions datalad/interface/unlock.py
Expand Up @@ -63,6 +63,16 @@ class Unlock(Interface):
recursion_limit=recursion_limit,
)

_examples_ = [
dict(text="""Unlock a single file""",
code_py="unlock(path='path/to/file')",
code_cmd="datalad unlock <path/to/file>"),
dict(text="Unlock all contents in the dataset",
code_py="unlock('.')",
code_cmd="datalad unlock ."),
]


@staticmethod
@datasetmethod(name='unlock')
@eval_results
Expand Down

0 comments on commit afbfd32

Please sign in to comment.