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

UX: known "patterns" to be displayed also for "download" #823

Closed
yarikoptic opened this issue Oct 28, 2021 · 0 comments · Fixed by #827
Closed

UX: known "patterns" to be displayed also for "download" #823

yarikoptic opened this issue Oct 28, 2021 · 0 comments · Fixed by #827
Assignees
Labels

Comments

@yarikoptic
Copy link
Member

Currently --help only of ls has

$> dandi ls --help
Usage: dandi ls [OPTIONS] [PATHS]...

  List .nwb files and dandisets metadata.

  Patterns for known setups:
   - DANDI:<dandiset id>
   - https://dandiarchive.org/...
   - https://identifiers.org/DANDI:<dandiset id>
   - https://<server>[/api]/[#/]dandiset/<dandiset id>[/<version>][/files[?location=<path>]]
   - https://*dandiarchive-org.netflify.app/...
   - https://<server>[/api]/dandisets/<dandiset id>[/versions[/<version>]]
   - https://<server>[/api]/assets/<asset id>[/download]
   - https://<server>[/api]/dandisets/<dandiset id>/versions/<version>/assets/<asset id>[/download]
   - https://<server>[/api]/dandisets/<dandiset id>/versions/<version>/assets/?path=<path>
   - dandi://<instance name>/<dandiset id>[@<version>][/<path>]
   - https://<server>/...

and for download we need user to make a mistake first to display them.

  • for ls it is actually a bit confusing: we say it operates on PATHs, but then talk about some "patterns" without providing context. Docstring (--help) and may be METAVAR (currently PATH now, but could be RI (Resource identifier)) should be adjusted to be more reflective of what we are talking about.
  • I would call those "patterns" to be "Resource Identifier (URLs included) patterns"
  • we need to add similar listing to download's --help

@satra -- may be you have also some ideas on how we should "name" and expose those all possibly "Resource Identifier patterns" we support?

@yarikoptic yarikoptic added the UX label Oct 28, 2021
yarikoptic added a commit that referenced this issue Nov 5, 2021
Improve `dandi ls --help` and `dandi download --help` output
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants