Skip to content
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

Closed
wants to merge 2 commits into from

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Oct 1, 2018

An attempt to solve issue #5 .
Also fixed a small typo in one DICOM tag

Copy link
Contributor

@chrisgorgo chrisgorgo left a 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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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-&lt;participant\_label&gt;/[ses-&lt;session\_label&gt;/]
> anat/
>> sub-&lt;participant\_label&gt;[\_ses-&lt;session\_label&gt;][\_acq-&lt;label&gt;][\_ce-&lt;label&gt;][\_rec-&lt;label&gt;][\_run-&lt;index&gt;][\_mod-&lt;label&gt;]\_defacemask.nii[.gz]
``` markdown
Copy link
Contributor

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?

@chrisgorgo
Copy link
Contributor

Actually I will handle this - hold on.

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Oct 1, 2018

I also saw that there bits of filepaths sometimes imbeded in text sections. Do we want those to appear as code too?

@chrisgorgo
Copy link
Contributor

yeah - I'm doing a pass theough the document now #13

@chrisgorgo
Copy link
Contributor

We covered this in recent PRs. Apologies for wasted effort. Early days...

@chrisgorgo chrisgorgo closed this Oct 3, 2018
@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Oct 3, 2018

No worries: this was anyway a good exercise for me to finally start getting better acquainted with markdown! :-)

@Remi-Gau Remi-Gau deleted the filepath_as_code branch October 9, 2018 14:56
franklin-feingold added a commit that referenced this pull request Feb 14, 2019
chrisgorgo added a commit that referenced this pull request Apr 14, 2019
[ENH] replacing `CoordinateSystem` replacement with `space` + examples
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.

2 participants