-
Notifications
You must be signed in to change notification settings - Fork 171
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
rewriting templates/filepath/examples as code #12
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a great first pass. Thanks for submitting. Could you remove syntax highlight from all section and only use the JSON
one for JSON snippets?
|
||
```markdown | ||
sub-01/ | ||
sub-01_task-xyz_acq-test1_bold.json |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you change this to 4 spaces?
@@ -331,40 +337,46 @@ Files for a particular participant can exist only at participant level directory | |||
Example 1: Two JSON files at same level that are applicable for NIfTI | |||
file. | |||
|
|||
```markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you remove syntax highlight from this section?
>>> sub-01\_task-xyz\_acq-test1\_rec-recon1\_bold.nii.gz | ||
>>> sub-01\_task-xyz\_acq-test1\_rec-recon2\_bold.nii.gz | ||
>>> sub-01\_task-xyz\_acq-test1\_bold.json | ||
```markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you remove syntax highlight from this section?
>>> sub-01\_task-xyz\_acq-test1\_rec-recon1\_bold.nii.gz | ||
>>> sub-01\_task-xyz\_acq-test1\_rec-recon2\_bold.nii.gz | ||
|
||
```markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you remove syntax highlight from this section?
"Units": "kilograms per squared meters", | ||
"TermURL": "http://purl.bioontology.org/ontology/SNOMEDCT/60621009" | ||
} | ||
```markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you switch syntax highlight to JSON
?
@@ -596,11 +610,12 @@ JavaScript Object Notation (JSON) files MUST be used for storing key/value pairs | |||
files MUST be in UTF-8 encoding. | |||
|
|||
### 4.3.1 Example: | |||
|
|||
``` markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you switch syntax highlight to JSON?
- dataset\_description.json | ||
- README | ||
- CHANGES | ||
``` markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you remove syntax highlight from here?
@@ -728,18 +746,19 @@ The file dataset\_description.json is a JSON file describing the dataset. Every | |||
</tbody> | |||
</table> | |||
|
|||
Example: | |||
Example: | |||
``` markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you switch syntax highlight to JSON?
sub-<participant\_label>/[ses-<session\_label>/] | ||
> anat/ | ||
>> sub-<participant\_label>[\_ses-<session\_label>][\_acq-<label>][\_ce-<label>][\_rec-<label>][\_run-<index>][\_mod-<label>]\_defacemask.nii[.gz] | ||
``` markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you remove syntax highlight?
Actually I will handle this - hold on. |
I also saw that there bits of filepaths sometimes imbeded in text sections. Do we want those to appear as code too? |
yeah - I'm doing a pass theough the document now #13 |
We covered this in recent PRs. Apologies for wasted effort. Early days... |
No worries: this was anyway a good exercise for me to finally start getting better acquainted with markdown! :-) |
[ENH] replacing `CoordinateSystem` replacement with `space` + examples
An attempt to solve issue #5 .
Also fixed a small typo in one DICOM tag