Cleaned up docstrings on methods#1285
Merged
VisLab merged 4 commits intohed-standard:mainfrom Mar 26, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the public-facing documentation of the HED Python codebase by adding/standardizing docstrings across validators, tools, and scripts, and by expanding the Sphinx API reference pages accordingly. It also hardens GitHub Actions workflows by explicitly setting minimal contents: read permissions.
Changes:
- Add/standardize Google-style docstrings for multiple validator/tool utility methods and CLI entry points.
- Expand Sphinx API docs to include additional validator/tool classes and utility modules.
- Add explicit
permissions: contents: readto selected GitHub Actions workflows.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
hed/validator/util/tag_util.py |
Adds docstring for deprecated-tag checking helper. |
hed/validator/util/string_util.py |
Documents run_string_validator behavior/return type. |
hed/validator/util/dup_util.py |
Adds module/class docstrings for duplicate-checking utility. |
hed/validator/util/class_util.py |
Adds docstrings to value-class reporting helpers and value-class validators. |
hed/validator/util/char_util.py |
Documents character-level validation helpers and return shapes. |
hed/validator/spreadsheet_validator.py |
Adds class docstring describing spreadsheet validation role. |
hed/validator/sidecar_validator.py |
Adds class docstring describing sidecar validation role. |
hed/validator/reserved_checker.py |
Adds module/class/method docstrings for reserved tag checking singleton. |
hed/tools/util/io_util.py |
Documents get_basename behavior and example. |
hed/tools/bids/bids_util.py |
Adds module/function docstrings for schema loading and sidecar inheritance utilities. |
hed/tools/bids/bids_file_group.py |
Documents create_file_group factory method. |
hed/tools/analysis/hed_type.py |
Documents key properties and summary methods. |
hed/tools/analysis/hed_tag_counts.py |
Documents get_empty helper. |
hed/tools/analysis/events_summary.py |
Adds module/class/method docstrings for event summarization helpers. |
hed/tools/analysis/event_checker.py |
Adds module/class docstrings for event-level quality checker(s). |
hed/scripts/validate_schemas.py |
Adds module docstring and documents main entry point contract. |
hed/scripts/validate_bids.py |
Documents CLI entry point and dataset-validation helper. |
hed/scripts/schema_script_util.py |
Adds module docstring describing shared CLI utilities. |
hed/scripts/hed_convert_schema.py |
Adds module docstring and documents main entry point contract. |
hed/scripts/add_hed_ids.py |
Adds module docstring and documents main entry point contract. |
hed/scripts/__init__.py |
Adds package docstring clarifying legacy/deprecated scripts. |
docs/api/validator.rst |
Expands validator API page with additional classes/utilities. |
docs/api/tools.rst |
Expands tools API page with additional analysis/BIDS/util modules and classes. |
.github/workflows/test_installer.yaml |
Adds explicit minimal GitHub Actions permissions. |
.github/workflows/spec_tests.yaml |
Adds explicit minimal GitHub Actions permissions. |
.github/workflows/ci_windows.yaml |
Adds explicit minimal GitHub Actions permissions. |
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.
No description provided.