[FIX] update highlighting of examples, JSON keys and values, and TSV headers or values in the schema#998
Conversation
| description: | | ||
| The `rec-<label>` key/value can be used to distinguish | ||
| different reconstruction algorithms (for example ones using motion | ||
| different reconstruction algorithms (for example `MoCo` for the ones using motion |
There was a problem hiding this comment.
This feels like common enough occurrence in scanners output to add it by name as an example
Codecov Report
@@ Coverage Diff @@
## master #998 +/- ##
==========================================
+ Coverage 34.05% 35.13% +1.07%
==========================================
Files 8 8
Lines 834 834
==========================================
+ Hits 284 293 +9
+ Misses 550 541 -9
Continue to review full report at Codecov.
|
src/schema/objects/metadata.yaml
Outdated
| defined based on the size of the reconstructed image in the phase direction. | ||
| It is frequently, but incorrectly, referred to as "dwell time" | ||
| (see `DwellTime` parameter below for actual dwell time). | ||
| (see `"DwellTime"` parameter for actual dwell time). |
There was a problem hiding this comment.
removed the below because this might not make sense in all context if this description was used in a table where DwellTime does not appear
tsalo
left a comment
There was a problem hiding this comment.
Overall, I like these changes. Just two things:
- Including a leading underscore when referring to suffixes/specific files (e.g.,
_events.tsv) seems less readable to me. - I'm not sure if you want to include quotes around fields when you're referring to the actual contents of the field, rather than the key. For example, in the
RepetitionTimeExcitationdescription, we have:
Use
RepetitionTimeExcitation(in combination with"RepetitionTimePreparation"if needed)
It seems like "RepetitionTimePreparation" should just be RepetitionTimePreparation in this case. That said, I don't feel strongly about this, so if you disagree then I'm happy to approve.
Co-authored-by: Taylor Salo <tsalo006@fiu.edu>
Yeah In a way I agree but this adds another implicit rule about formatting that will be hard to keep track off and potentially confuse users, no? |
sappelhoff
left a comment
There was a problem hiding this comment.
it seems like you removed the leading underscores again based on a comment by Taylor. I think you missed two instances (see comments).
I also like events.tsv better than _events.tsv even though I know I've been using both in the past
Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>
Thanks for catching those too!! |
Resolves bids-standard#947 against: - bids-standard#962 (21b7725) - bids-standard#1044 (d9eeb6d) - bids-standard#867 (5fe26e1) - bids-standard#998 (e47283a) Conflicts: src/02-common-principles.md src/schema/README.md src/schema/objects/entities.yaml src/schema/objects/metadata.yaml
closes #746
make sure that that examples appear "as they should" be in JSON or TSV files
1"Key"or"n/a"1or like thisn/aI am sure I have missed some but this is a never ending battle (and I don't thing we want to automate or CI check this) so I suggest that this should close #746