Skip to content

Corrected style to use one space after period#1267

Merged
VisLab merged 2 commits into
hed-standard:mainfrom
VisLab:fix_extras
Mar 13, 2026
Merged

Corrected style to use one space after period#1267
VisLab merged 2 commits into
hed-standard:mainfrom
VisLab:fix_extras

Conversation

@VisLab

@VisLab VisLab commented Mar 13, 2026

Copy link
Copy Markdown
Member

No description provided.

@github-actions

Copy link
Copy Markdown

PR Review: Corrected style to use one space after period

This PR is a clean, purely cosmetic change replacing double spaces after periods with single spaces across the codebase. The scope is consistent and appropriate: only comments, docstrings, error messages, and inline string literals are touched, no logic is affected.

One issue found:

Important — hed/schema/schema_io/hed_id_util.py: One docstring edit silently drops content. The original line read:

df_key(str): The dataframe range type we're interested in.  a key from constants.DF_SUFFIXES.

The new version is:

df_key(str): The dataframe range type we're interested in.

The trailing clause (a key from constants.DF_SUFFIXES.) was removed entirely rather than kept after the corrected single space. This loses useful documentation about valid values for the parameter. The fix is to restore it: 'The dataframe range type we're interested in. A key from constants.DF_SUFFIXES.'

Minor observations (no action required):

  • A handful of changes go slightly beyond spacing: adding 'It' before 'does not check value' in attribute_validators.py, adding 'The' before '.tsv files' in two schema_script_util.py print statements, and converting 'Eg' to 'e.g.,' in several docstrings. These are all improvements and fine to include.
  • Error message strings are changed in error_messages.py and schema_error_messages.py. HED error reporting is code-based (not string-matched), so these do not affect backward compatibility.

Verdict: Approve once the dropped documentation in hed_id_util.py is restored.

Comment thread hed/schema/schema_io/hed_id_util.py
@VisLab VisLab merged commit 804e17a into hed-standard:main Mar 13, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant