-
Notifications
You must be signed in to change notification settings - Fork 11
Updated the docs for hed-python #1169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates documentation and terminology across the HED Python tools repository. The main focus is on standardizing terminology (e.g., "HEDTools" vs "hedtools"), improving documentation clarity, updating links, and making a minor API change to make an internal method private.
Key changes:
- Renamed
extract_definitions()to_extract_definitions()inSidecarclass to indicate it's an internal method, with corresponding test updates - Standardized capitalization of "HEDTools" and related terms throughout documentation
- Updated and improved documentation for user guide, introduction, README, and API references
- Enhanced command-line tool documentation with more detailed format descriptions
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/models/test_sidecar.py | Updated test to call _extract_definitions() instead of extract_definitions() |
| tests/models/test_base_input.py | Updated test to call _extract_definitions() instead of extract_definitions() |
| hed/scripts/validate_bids.py | Standardized "HEDTools" capitalization and expanded format help text |
| hed/models/sidecar.py | Renamed extract_definitions() to _extract_definitions() to make it private |
| examples/extract_json_template.ipynb | Added metadata, reformatted cells, updated terminology |
| examples/README.md | Reformatted tables, standardized headings, updated links |
| docs/user_guide.md | Extensive updates: fixed terminology, improved explanations, added sections, updated code examples |
| docs/introduction.md | Standardized terminology, updated links, improved quick start examples |
| docs/index.rst | Added explicit titles to TOC entries |
| docs/api/validator.rst | Standardized heading capitalization |
| docs/api/tools.rst | Standardized heading capitalization |
| docs/api/schema.rst | Standardized heading capitalization |
| docs/api/models.rst | Standardized heading capitalization |
| docs/api/index.rst | Standardized heading capitalization and title |
| docs/api/errors.rst | Standardized heading capitalization |
| docs/_templates/quicklinks.html | Added table-remodeler link |
| docs/_static/custom.css | Added dark mode support for auto mode with system preference |
| README.md | Standardized terminology, updated links, improved formatting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.