Skip to content

Commit f89f306

Browse files
committed
Docs: deduplicate the validate page after merging the docs branch
Git merged the synced option reference and this branch's additions without conflict but with the `--missing-file-content`, `--format`, and `--output` entries and the link targets appearing twice, which Sphinx rejects. Keep the synced entries, adding the `stream` policy to `--missing-file-content`, and the "Validating DataLad Dandisets" section. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HFhMPs6vF5zyeHDvPTvRcA
1 parent f5592ae commit f89f306

1 file changed

Lines changed: 5 additions & 34 deletions

File tree

‎docs/source/cmdline/validate.rst‎

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -56,33 +56,6 @@ Options
5656
Limit the number of results shown per group (or in total when not
5757
grouping); the excess is replaced by a count of omitted results
5858

59-
.. option:: --missing-file-content [error|only-non-data|skip]
60-
61-
How to handle files whose content is unavailable, such as the broken
62-
symbolic links of a DataLad_ dataset (a git-annex_ repository) whose
63-
content has not been fetched:
64-
65-
``error``
66-
Emit a concise ``DANDI.FILE_CONTENT_MISSING`` error for each such file
67-
(default)
68-
69-
``skip``
70-
Skip each such file, emitting a warning
71-
72-
``only-non-data``
73-
Skip content-dependent validators (pynwb, nwbinspector, ...) for each
74-
such file but still validate its path layout
75-
76-
.. option:: --load <file>
77-
78-
Instead of running validation, load previously saved results from the
79-
given JSON Lines file (e.g., an automatically saved companion file) and
80-
render them. Can be specified multiple times; cannot be combined with
81-
paths.
82-
83-
.. _DataLad: https://www.datalad.org
84-
.. _git-annex: https://git-annex.branchable.com
85-
8659
.. option:: --missing-file-content [error|only-non-data|skip|stream]
8760

8861
How to handle files whose content is unavailable, such as the broken
@@ -105,14 +78,12 @@ Options
10578
git-annex so that content-dependent validators run without the file
10679
having to be downloaded; see `Validating DataLad Dandisets`_ below.
10780

108-
.. option:: -f, --format [text|json|json_pp|json_lines|yaml]
109-
110-
Output format (``text`` by default)
111-
112-
.. option:: -o, --output <file>
81+
.. option:: --load <file>
11382

114-
Write the output to the given file instead of standard output. The format
115-
is inferred from the file's extension unless :option:`--format` is given.
83+
Instead of running validation, load previously saved results from the
84+
given JSON Lines file (e.g., an automatically saved companion file) and
85+
render them. Can be specified multiple times; cannot be combined with
86+
paths.
11687

11788
.. _DataLad: https://www.datalad.org
11889
.. _git-annex: https://git-annex.branchable.com

0 commit comments

Comments
 (0)