Updating Appendix A for new formats#671
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request updates Appendix A of the HED specification to document new schema formats (JSON and TSV), while also modernizing the project dependencies and reorganizing the documentation structure. The changes support the evolution of the HED ecosystem by providing comprehensive documentation for the newer schema file formats introduced in version 8.5.0.
Changes:
- Added comprehensive documentation for JSON and TSV schema formats in Appendix A
- Updated schema version references from 8.0.0/8.4.0 to 8.5.0 throughout Appendix A
- Modernized Python development dependencies (Sphinx, Furo, Black, Ruff, mdformat)
- Restructured documentation index with clearer sectioning (Core specification, Advanced topics, Reference materials)
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| pyproject.toml | Consolidated dev dependencies, removed separate docs/quality groups, updated package versions |
| docs/source/index.rst | Reorganized table of contents into logical sections with separate toctrees |
| docs/source/conf.py | Added keyboard navigation support for Furo theme |
| docs/source/Appendix_A.md | Updated schema version to 8.5.0, updated unit class tables, added detailed JSON format section (A.4), added comprehensive TSV format section (A.5), expanded attribute descriptions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This will need several PRs to update fully.