Skip to content

Update docs: bring the command-line reference in sync with the CLI - #1934

Merged
yarikoptic merged 1 commit into
masterfrom
claude/docs-cli-options-sync
Sep 28, 2026
Merged

yarikoptic merged 1 commit into
masterfrom
claude/docs-cli-options-sync

Conversation

@CodyCBakerPhD

Copy link
Copy Markdown
Contributor

Split out of initial version of #1933

dandi validate gained many options that its page never documented: --grouping now takes seven repeatable keys, --min-severity five levels, and --format, --output, --summary, --max-per-group, --missing-file-content, and --load were missing altogether, as was the automatically saved JSON Lines companion file. Also document download --zarr, organize --jobs, and upload --zarr-mode, and add a page for the deprecated validate-bids pointing to validate.

Claude-Session: https://claude.ai/code/session_01HFhMPs6vF5zyeHDvPTvRcA

`dandi validate` gained many options that its page never documented:
`--grouping` now takes seven repeatable keys, `--min-severity` five levels,
and `--format`, `--output`, `--summary`, `--max-per-group`,
`--missing-file-content`, and `--load` were missing altogether, as was the
automatically saved JSON Lines companion file.  Also document
`download --zarr`, `organize --jobs`, and `upload --zarr-mode`, and add a
page for the deprecated `validate-bids` pointing to `validate`.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HFhMPs6vF5zyeHDvPTvRcA
@CodyCBakerPhD CodyCBakerPhD self-assigned this Sep 27, 2026
@codecov

codecov Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.30%. Comparing base (c3931cc) to head (b294fc9).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1934   +/-   ##
=======================================
  Coverage   78.30%   78.30%           
=======================================
  Files          92       92           
  Lines       14068    14068           
=======================================
  Hits        11016    11016           
  Misses       3052     3052           
Flag Coverage Δ
unittests 78.30% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@CodyCBakerPhD CodyCBakerPhD added the documentation Changes only affect the documentation label Sep 27, 2026
@CodyCBakerPhD
CodyCBakerPhD added this pull request to stack #1935 September 27, 2026 17:53
@CodyCBakerPhD
CodyCBakerPhD removed this pull request from stack #1935 September 27, 2026 18:04
@CodyCBakerPhD
CodyCBakerPhD added this pull request to stack #1938 September 27, 2026 18:05
@CodyCBakerPhD
CodyCBakerPhD removed this pull request from stack #1938 September 27, 2026 19:28
@CodyCBakerPhD
CodyCBakerPhD added this pull request to stack #1940 September 27, 2026 19:29
@CodyCBakerPhD
CodyCBakerPhD removed this pull request from stack #1940 September 27, 2026 20:17
@CodyCBakerPhD
CodyCBakerPhD added this pull request to stack #1942 September 27, 2026 20:17
Comment thread docs/source/cmdline/download.rst
@yarikoptic
yarikoptic merged commit c2d4457 into master Sep 28, 2026
43 of 44 checks passed
@yarikoptic
yarikoptic deleted the claude/docs-cli-options-sync branch September 28, 2026 14:38
@github-actions

Copy link
Copy Markdown

🚀 PR was released in 0.81.0 🚀

yarikoptic-gitmate pushed a commit that referenced this pull request Oct 5, 2026
Conflict in docs/source/cmdline/download.rst: #1934 documented `--zarr`
on master while this branch documented it too.  Resolved onto master's
wording and `.. option:: --zarr FILTER` heading, keeping the material
only this branch has — the `--sync` mutual exclusion, the URL-subpath
form and its error-on-no-match semantics, the warning that a URL subpath
and `--zarr` are unioned rather than intersected, and the note that a
partial download skips extra-file deletion and the whole-Zarr checksum.

Also corrected master's `metadata` description while merging: the alias
is `**/.z*` plus `**/zarr.json`, so it selects any entry whose name
begins with `.z`, not only the four names listed.

The dev-deps workflow change merged cleanly: #1928 landed on master with
the same content this branch had ported.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011qh3EwgNtANXokhr1uimHG
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only affect the documentation released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants