Cleaned up the documentation for the hedpy #1176
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request performs a comprehensive documentation cleanup and reorganization of the HEDTools command-line interface (hedpy). The changes focus on improving help text, restructuring CLI commands from flat to grouped organization, and updating dependencies.
Key changes:
- Restructured CLI from flat commands (
validate-bids,extract-sidecar) to grouped commands (validate bids-dataset,extract bids-sidecar,extract tabular-summary) - Enhanced documentation strings and help text across all CLI commands and scripts with more detailed examples and clearer explanations
- Changed error limit option short flag from
-ecto-elfor better consistency - Added
mdformatandmdformat-mystto dev dependencies while removingmdformat-tables - Updated GitHub Actions to use cache@v6 (though this version doesn't exist)
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_cli_parameter_parity.py | Updated tests to match new grouped CLI command structure and added test for extract tabular-summary |
| requirements-dev.txt | Added mdformat packages for markdown formatting |
| hed/scripts/validate_bids.py | Enhanced documentation with detailed examples, reorganized argument groups, changed -ec to -el |
| hed/scripts/hed_extract_bids_sidecar.py | Improved help text and examples, made suffix optional with default value |
| hed/scripts/extract_tabular_summary.py | Enhanced documentation and reorganized argument groups for consistency |
| hed/cli/cli.py | Major refactoring: grouped commands, added click-option-group for better help organization, extensive help text improvements |
| docs/user_guide.md | Updated all command references from flat to grouped structure, updated flag references |
| README.md | Reorganized badges for better visual presentation |
| .github/workflows/mdformat.yaml | Updated to use actions/cache@v6 |
| .github/workflows/docs.yaml | Updated to use actions/cache@v6 |
| .github/workflows/ci_windows.yaml | Updated to use actions/cache@v6 |
| .github/workflows/ci.yaml | Updated to use actions/cache@v6 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.