Standardize core schema documentation style#704
Draft
ehennestad wants to merge 12 commits into
Draft
Conversation
ehennestad
force-pushed
the
codex/fix-core-schema-doc-style
branch
from
d24593f to
9bf38f5
Compare
ehennestad
force-pushed
the
codex/fix-core-schema-doc-style
branch
from
9bf38f5 to
1ba8620
Compare
- nwb.file.yaml: stimuluation -> stimulation; as as -> as; the a sequence -> a sequence; experimental experimental_conditions -> experimental conditions; experiment`s -> experiment's (backtick used as apostrophe) - nwb.ecephys.yaml: zero- filled -> zero-filled (erroneous space in hyphenated compound) - nwb.retinotopy.yaml: stray leading quote before ['radius', 'theta'] example Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
All other DEPRECATED tags in the schema use 'DEPRECATED.' with a period before the sentence that follows. Fix the three inconsistent instances in nwb.ecephys.yaml (ClusterWaveforms, Clustering) and nwb.ophys.yaml (ImagingPlane.manifold). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- nwb.ecephys.yaml: two instances of 'i.e,' corrected to 'i.e.,'; missing terminal periods on ClusterWaveforms.waveform_mean, waveform_sd, and clustering_interface link doc - nwb.icephys.yaml: missing terminal periods on IZeroClampSeries.stimulus_description and IntracellularResponsesTable.response - nwb.retinotopy.yaml: missing terminal period on vasculature_image.bits_per_pixel Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- nwb.ophys.yaml: 'w/' -> 'with'; 'x & y' -> 'x and y' - nwb.retinotopy.yaml: 'Right now only' -> 'Currently only' (x2) - nwb.image.yaml: contraction 'it's' -> 'it is' - nwb.ecephys.yaml: contraction 'it's' -> 'it is' Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- nwb.file.yaml: 'than' -> 'that' (Place-holder); 'these be used' -> 'these can be used'; 'after experiment complete' -> 'after the experiment is complete'; 'to common timebase' -> 'to a common timebase'; fix comma placement after 'both'; 'etc,' -> 'etc.' - nwb.icephys.yaml: 'allows to group' -> 'allows users to group'; remove double space after 'e.g.,' - nwb.behavior.yaml: 'take the output one specific' -> 'output of one specific'; 'is published' -> 'are published' (plural subject); 'si_unit' -> 'unit' (field does not exist); 'axis' -> 'axes'; remove double space after sentence-ending period Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- nwb.ophys.yaml: 'larger numbers in x/y/z means' -> 'mean' (plural subject; three instances in ImagingPlane.reference_frame) - nwb.misc.yaml: 'for visual grating stimulus' -> 'for a visual grating stimulus' (missing article) - nwb.retinotopy.yaml: 'taken with same settings' -> 'taken with the same settings' (missing article) - nwb.image.yaml: 'must contain a order_of_images' -> 'an' (article before vowel-initial quoted word) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replacing the backtick with an apostrophe in the previous commit left an unescaped single quote inside a single-quoted YAML scalar. Remove the outer single quotes — the string contains no characters that require quoting. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ehennestad
force-pushed
the
codex/fix-core-schema-doc-style
branch
from
f27eb3d to
79a8442
Compare
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
Overall the current changes look good to me. Could you add an entry to the changelog. |
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
2 participants
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.
NB: This PR is stacked on #695 and should be reviewed after that PR.
Summary of changes
1-D,2-D, and3-D.e.g.,andi.e.,punctuation throughout the core schema documentation.Subject.sexdescription to refer to biological sex rather than gender.Checklist
For all schema changes:
docs/format/source/format_release_notes.rst. Not applicable: this PR changes documentation strings only and is stacked on Fix copy-paste doc errors in icephys, image, misc, and ophys schemas #695, which contains the release update.hdmf-common-schemapoints to the latest release and not the latest commit on themainbranch.