Skip to content

Commit 2a1b3f8

Browse files
yarikopticclaude
andcommitted
fix: Correct typos and formatting in specification documents
Fixed several language and formatting errors discovered during comprehensive proofing of specification files using the proof-spec skill: In src/common-principles.md: - Line 18: Fixed duplicated "be" in "cannot be be interpreted" - Line 96: Changed "unapplicable" to correct form "inapplicable" - Line 634: Removed duplicated "files" in "files files MUST NOT" - Line 1070: Fixed duplicated "is" to "it is RECOMMENDED" In src/CHANGES.md: - Line 80: Wrapped literal URL in angle brackets per markdown style guide (remark-lint: no-literal-urls rule) In src/appendices/meg-systems.md: - Line 17: Fixed broken table separator with space in middle - Auto-formatted table for consistency In src/schema/objects/entities.yaml: - Line 153: Fixed missing closing quote in "InversionTime" metadata field reference In src/schema/rules/checks/deprecations.yml: - Line 1: Added missing YAML document start marker (---) to resolve yamllint warning All fixes improve readability and correctness of the specification without changing any technical requirements or meaning. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 373da35 commit 2a1b3f8

File tree

5 files changed

+22
-21
lines changed

5 files changed

+22
-21
lines changed

src/CHANGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
- \[FIX] Add misssing files in filename template for NIRS [1716](https://github.com/bids-standard/bids-specification/pull/1716) ([Remi-Gau](https://github.com/Remi-Gau))
7878
- \[FIX] Remove task entity from DWI and PERF time series file templates [1703](https://github.com/bids-standard/bids-specification/pull/1703) ([Remi-Gau](https://github.com/Remi-Gau))
7979
- \[FIX] Add `part-<value>` to the PEPOLAR fieldmaps [1685](https://github.com/bids-standard/bids-specification/pull/1685) ([oesteban](https://github.com/oesteban))
80-
- \[INFRA] Publish schema to Javascript Registry (https://jsr.io/@bids/schema) on changes and releases [1899](https://github.com/bids-standard/bids-specification/pull/1899) ([effigies](https://github.com/effigies))
80+
- \[INFRA] Publish schema to Javascript Registry (<https://jsr.io/@bids/schema>) on changes and releases [1899](https://github.com/bids-standard/bids-specification/pull/1899) ([effigies](https://github.com/effigies))
8181
- \[INFRA] Introduce metaschema [1787](https://github.com/bids-standard/bids-specification/pull/1787) ([bendichter](https://github.com/bendichter))
8282
- \[MISC] Restructure MEG empty room example texts [1677](https://github.com/bids-standard/bids-specification/pull/1677) ([guiomar](https://github.com/guiomar))
8383

src/appendices/meg-systems.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ Preferred names of MEG systems comprise restricted keywords for Manufacturer fie
1313

1414
Restricted keywords for ManufacturersModelName field in the `*_meg.json` file:
1515

16-
| **System Model Name** | **Manufacturer** | **Details** |
17-
| ------------------------- | --------- ----------- | -------------------------------------------------------------------------------------------- |
18-
| CTF-64 | CTF | |
19-
| CTF-151 | CTF | [https://www.ctf.com/products](https://www.ctf.com/products) |
20-
| CTF-275 | CTF | CTF-275: OMEGA 2000 |
21-
| Neuromag-122 | Neuromag/Elekta/Megin | |
22-
| ElektaVectorview | Neuromag/Elekta/Megin | 102 magnetometers + 204 planar gradiometers |
23-
| ElektaTRIUX | Neuromag/Elekta/Megin | [https://www.elekta.com/products/neurosurgery/](https://www.elekta.com/products/neurosurgery/) |
24-
| 4D-Magnes-WH2500 | BTi/4D | |
25-
| 4D-Magnes-WH3600 | BTi/4D | |
26-
| KIT-157 | KIT/Yokogawa | |
27-
| KIT-160 | KIT/Yokogawa | |
28-
| KIT-208 | KIT/Yokogawa | |
29-
| ITAB-ARGOS153 | ITAB | |
30-
| Aalto-MEG-MRI-YYYY/MM | Aalto/MEG-MRI | YYYY-MM (year, month; or major version) |
16+
| **System Model Name** | **Manufacturer** | **Details** |
17+
| --------------------- | --------------------- | ----------------------------------------------- |
18+
| CTF-64 | CTF | |
19+
| CTF-151 | CTF | <https://www.ctf.com/products> |
20+
| CTF-275 | CTF | CTF-275: OMEGA 2000 |
21+
| Neuromag-122 | Neuromag/Elekta/Megin | |
22+
| ElektaVectorview | Neuromag/Elekta/Megin | 102 magnetometers + 204 planar gradiometers |
23+
| ElektaTRIUX | Neuromag/Elekta/Megin | <https://www.elekta.com/products/neurosurgery/> |
24+
| 4D-Magnes-WH2500 | BTi/4D | |
25+
| 4D-Magnes-WH3600 | BTi/4D | |
26+
| KIT-157 | KIT/Yokogawa | |
27+
| KIT-160 | KIT/Yokogawa | |
28+
| KIT-208 | KIT/Yokogawa | |
29+
| ITAB-ARGOS153 | ITAB | |
30+
| Aalto-MEG-MRI-YYYY/MM | Aalto/MEG-MRI | YYYY-MM (year, month; or major version) |

src/common-principles.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ REQUIRED, RECOMMENDED, and OPTIONAL.
1515
The guiding principles for when particular data is placed under a given requirement level
1616
can be loosely described as below:
1717

18-
- REQUIRED: Data cannot be be interpreted without this information (or the ambiguity is unacceptably high)
18+
- REQUIRED: Data cannot be interpreted without this information (or the ambiguity is unacceptably high)
1919
- RECOMMENDED: Interpretation/utility would be dramatically improved with this information
2020
- OPTIONAL: Users and/or tools might find it useful to have this information
2121

@@ -93,7 +93,7 @@ be reviewed to include common data types in the future releases of the BIDS
9393
specification.
9494

9595
It is RECOMMENDED that non-compulsory metadata fields (like `notch` in `channels.tsv` files)
96-
and/or files (like `events.tsv`) are fully omitted *when they are unavailable or unapplicable*,
96+
and/or files (like `events.tsv`) are fully omitted *when they are unavailable or inapplicable*,
9797
instead of specified with an `n/a` value, or included as an empty file
9898
(for example an empty `events.tsv` file with only the headers included).
9999

@@ -631,7 +631,7 @@ Rules for formatting plain-text tabular files apply to TSVGZ files with three ex
631631
!!! warning "Attention"
632632

633633
In contrast to plain-text TSV files,
634-
compressed tabular files files MUST NOT include a header line.
634+
compressed tabular files MUST NOT include a header line.
635635
Column names MUST be provided in the JSON file with the
636636
[`Columns`](glossary.md#columns-metadata) field.
637637
Each column MAY additionally be described with a column description,
@@ -1067,7 +1067,7 @@ Describing dates and timestamps:
10671067
- Dates can be shifted by a random number of days for privacy protection
10681068
reasons.
10691069
To distinguish real dates from shifted dates,
1070-
is is RECOMMENDED to set shifted dates to the year 1925 or earlier.
1070+
it is RECOMMENDED to set shifted dates to the year 1925 or earlier.
10711071
Note that some data formats do not support arbitrary recording dates.
10721072
For example, the [EDF](https://www.edfplus.info/)
10731073
data format can only contain recording dates after 1985.

src/schema/objects/entities.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ inversion:
150150
If files belonging to an entity-linked file collection are acquired at different inversion times,
151151
the `inv-<index>` entity MUST be used to distinguish individual files.
152152
153-
This entity represents the `"InversionTime` metadata field.
153+
This entity represents the `"InversionTime"` metadata field.
154154
Therefore, if the `inv-<index>` entity is present in a filename,
155155
`"InversionTime"` MUST be defined in the associated metadata.
156156
Please note that the `<index>` denotes the number/index (in the form of a nonnegative integer),

src/schema/rules/checks/deprecations.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
AnatomicalLandmarkCoordinateSystemDeprecation:
23
issue:
34
code: ELEKTA_NEUROMAG_DEPRECATED

0 commit comments

Comments
 (0)