search

datalad / datalad-catalog

Create a user-friendly data catalog from structured metadata
https://datalad-catalog.netlify.app
MIT License
14 stars 12 forks source link

`datalad catalog create` requires an *option* `--catalog_dir` #310

Closed mih closed 1 month ago

mih commented 1 year ago

The naming is off wrt to datalad conventions (should be --catalog-dir). Conceptually this should probably be an argument, not an option.

Maybe it could/should also have a sensible default (maybe CWD)?

Update: so the option name is OK, just the error message mislead me:

❯ datalad catalog create
catalog_create(impossible): [Datalad catalog create requires a path to operate on. Forgot -c, --catalog_dir?]

Update2: It would be useful to clarify the semantics of catalog-dir in the help output. It says "Directory where the catalog is located or will be created". Too many things are a catalog, I think. --metadata can also be considered to point to a catalog (of JSON records). Maybe spell it out "rendered" or "HTML" catalog?

jsheunis commented 1 month ago

Closing this since the command was revamped with the v1 release previously.