Expand validation docs for dandi-cli#1822 (companion JSONL, grouping, VisiData)#235
Expand validation docs for dandi-cli#1822 (companion JSONL, grouping, VisiData)#235yarikoptic wants to merge 4 commits intomasterfrom
Conversation
✅ Deploy Preview for dandi-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
@yarikoptic What is your plan to guarantee the examples stay up to date? I don't see any CRON / CI here to check or notify of differences / submit updates
Don't want things getting out of sync
|
@yarikoptic Thank you for setting up the deploy preview, that helps considerably Do you have any guess as to how hard it might be to do something like that for the DANDI Archive? (if only the web front end since I imagine backend would be tough) EDIT: I see
Can you look into this? My original thought was to have such things on the DANDI-CLI testing suite since that is closer to where code changes would break such things |
|
|
||
| On a dataset with actual errors (missing README, wrong file extension): | ||
|
|
||
| ```console |
There was a problem hiding this comment.
@yarikoptic Remind me, are these lines of code tested through a doctest of some kind?
…rsist validation logs)
=== Do not change lines below ===
{
"chain": [],
"cmd": "yolo -v /home/yoh/proj/dandi/dandi-cli-enh-validators:/home/yoh/proj/dandi/dandi-cli-enh-validators:ro -- 'In /home/yoh/proj/dandi/dandi-cli-enh-validators which is submitted as dandi/dandi-cli#1822 we significantly improved validation interfacing -- we serialize validation outputs and store so we could reload and potentially review with different filtering or use external tools like visidata to navigate. I would like here to improve our https://docs.dandiarchive.org/user-guide-sharing/validating-files/ section with improved documentation, reflecting the state of that PR. We should demonstrate that we store companion validation files during upload so they could be re-reviewed/analyzed. We should show basic use of visidata to quickly review them. Could use bids-examples repo and some sample dandisets (should be sufficiently small) to show how e.g. to compose multiple validation files. Ideally we should script production of example outputs, and/or store/share validation output example for easier access. Do research how other projects using mkdocs produce similar demo walkthroughs, and what we have done so far in this repo. Do research, build plan for content and also implementation details.'",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
…rsist validation logs)
=== Do not change lines below ===
{
"chain": [],
"cmd": "yolo -v /home/yoh/proj/dandi/dandi-cli-enh-validators:/home/yoh/proj/dandi/dandi-cli-enh-validators:ro -- --resume",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
- Fix asciinema-player cast file path for use_directory_urls (../ -> ../../) - Rename "Validating BIDS Files" -> "Validating BIDS Datasets" - Longer pauses after demo-say narration (2s -> 4s) for readability - Add pauses after typed VisiData commands (go-col-regex, search) - Use clean "validation-demo $" prompt instead of leaking absolute paths - Add record.sh driver for headless asciinema recording via Xvfb - Re-record visidata-demo.cast with all improvements Co-Authored-By: Claude Code 2.1.92 / Claude Opus 4.6 <noreply@anthropic.com>
yarikoptic
force-pushed
the
enh-validation
branch
from
0015ae8 to
de1b5a3
Compare
we already had this for long time -- it is a frontend and backend IIRC working against staging S3, eg from dandi/dandi-archive#2771 
|
2 participants
Summary
Major expansion of the Validating Files documentation to cover the new validation features from dandi/dandi-cli#1822.
validating-files.mdfrom ~53 to ~360 lines with new sections:dandi validateusage with tabbed output format examples (text/JSON/YAML/JSONL)--min-severity,--ignore) and grouping (-g severity -g id) with real output--output,--load, automatic JSONL companion files)dandi validateruns on Dandiset 000027 (NWB) and bids-examples/bids-error-examples (BIDS)record.shvia Xvfb + xdotool)New files
docs/examples/validation/*.txt,jsonl,yaml,jsondocs/examples/validation/visidata-demo.castscripts/generate-validation-examples.shscripts/visidata-demo/{demo.sh,record.sh,dot_visidatarc}Dependencies
--load,--grouping,--summary,--format json_lines, companion JSONL) are from that PRTest plan
mkdocs buildsucceeds with no errors🤖 Generated with Claude Code
Extra TODOs for humans: