Skip to content
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.

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

Add docstring to the mode parameter #198

Merged
merged 1 commit into from
May 29, 2024
Merged
Changes from all commits
Commits
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
24 changes: 23 additions & 1 deletion datalad_osf/create_sibling_osf.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,29 @@ class CreateSiblingOSF(Interface):
specified, the default git-annex trust level is used.""",),
mode=Parameter(
args=("--mode",),
doc=""" """,
doc="""Siblings can be created in various modes: annex', 'export',
'exportonly', and 'gitonly'. 'annex' uses the OSF node as joint
publication point for a representation of a Git repository as well
as a key-value store. This representation can be cloned from, and
used by git-annex to copy data to and retrieve data from (latest
and past versions), but the OSF project webinterface does not show
human-readable file names.
'export' uses the OSF node as joint publication point for a
representation of a Git repository as well as a snapshot of the
latest version of the annexed files. This representation can be
cloned from, and used by git-annex to export or retrieve the latest
annexed data. The OSF project webinterface will contain
human-readable file names.
'exportonly' uses 'git annex export' to publish a snapshot of a
particular version of the dataset. Such an OSF node will be
human-readable, but not clone-able.
The 'gitonly' mode allows to publish a representation of a Git
repository to the OSF that can be cloned from, but does not store
any annexed data.
All modes that allow 'push' to deposit a Git repository
representation make use of datalad-next's 'datalad_annex' remote
helper. Please see datalad-next's documentation for detailed
information about the resulting layout.""",
constraints=EnsureChoice(
"annex", "export", "exportonly", "gitonly")
),
Expand Down
Loading