Removed remodeler CLI for hedpy, updated docs #1168
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 PR removes the remodeler CLI commands from the hedpy unified CLI interface and updates documentation terminology for consistency, standardizing "MediaWiki" to "MEDIAWIKI" format naming across the codebase.
Key changes:
- Removed remodel CLI commands (
hedpy remodel run,hedpy remodel backup,hedpy remodel restore) and their entry points - Updated documentation terminology from "MediaWiki" to "MEDIAWIKI" for schema format references
- Added comprehensive CLI documentation to the user guide with detailed usage examples
- Enhanced development tooling with
black[jupyter]support for notebook formatting
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_cli_parameter_parity.py | Removed remodel command imports and test cases for backup, restore, and run operations |
| tests/schema/test_schema_format_roundtrip.py | Updated "MediaWiki" to "MEDIAWIKI" in test strings and comments |
| requirements-dev.txt | Added black[jupyter] for Jupyter notebook formatting support |
| pyproject.toml | Removed three remodel CLI entry points (run_remodel, run_remodel_backup, run_remodel_restore) |
| hed/scripts/hed_script_util.py | Updated docstrings to use "MEDIAWIKI" terminology |
| hed/schema/schema_io/wiki2schema.py | Updated class and method docstrings to use "MEDIAWIKI" terminology |
| hed/schema/schema_io/schema2wiki.py | Updated module docstring to use "MEDIAWIKI" format reference |
| hed/schema/schema_io/schema2base.py | Updated docstrings to list all supported formats (MEDIAWIKI/XML/JSON/TSV) |
| hed/schema/schema_io/json2schema.py | Updated code comments to use "MEDIAWIKI" terminology |
| hed/schema/hed_schema_io.py | Updated docstrings to reference "MEDIAWIKI" and add JSON to supported formats |
| hed/schema/hed_schema.py | Updated docstrings to use "MEDIAWIKI" terminology |
| hed/cli/cli.py | Removed remodel command group and all three remodel subcommands; updated help text |
| examples/*.ipynb | Applied black formatter (double quotes, improved line breaks) |
| docs/user_guide.md | Added comprehensive CLI documentation with detailed usage examples and workflows |
| docs/introduction.md | Updated format terminology to "MEDIAWIKI" and improved link formatting |
| docs/conf.py | Changed project title casing from "HED Python Tools" to "HED Python tools" |
| docs/_templates/sidebar/brand.html | New file: Added sidebar brand template for project name display |
| docs/_static/custom.css | Added CSS styling for sidebar project name with dark mode support |
| README.md | Updated schema format terminology from "MediaWiki" to "MEDIAWIKI" |
| CHANGELOG.md | Updated terminology to "MEDIAWIKI" in release notes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Compare all formats to each other | ||
| self.assertEqual( | ||
| schema_from_xml, schema_from_mediawiki, f"XML vs MediaWiki mismatch for {schema_name} (save_merged={save_merged})" | ||
| schema_from_xml, schema_from_mediawiki, f"XML vs MEDIAWI mismatch for {schema_name} (save_merged={save_merged})" |
There was a problem hiding this comment.
Typo in error message: "MEDIAWI" should be "MEDIAWIKI" (missing the "KI" at the end).
Suggested change
| schema_from_xml, schema_from_mediawiki, f"XML vs MEDIAWI mismatch for {schema_name} (save_merged={save_merged})" | |
| schema_from_xml, schema_from_mediawiki, f"XML vs MEDIAWIKI mismatch for {schema_name} (save_merged={save_merged})" |
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.