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

DOC: Miscellaneous improvements and fixes to the file format table #55

Merged

Conversation

jhlegarreta
Copy link
Contributor

Miscellaneous improvements and fixes to the file format table

  • Avoid adding an additional column and link to the format documentation using the names.
  • Fix the DICOM format extension: leave it to none and add a note about its most typical extension (.dcm).
  • Remove the unnecessary nii.gz and mgh.gz file extensions: add a note about cases where files have been compressed using an third-party tool (e.g. gzip).
  • Do not use third-party links for the NIfTI format: use the official NIfTI format webiste for its link.
  • Redirect to the DICOM format documentation instead of the general DICOM standard landing page.
  • Add Gordon Kindlmann as the origin/creator of the NRRD format.
  • Remove unnecessary whitespaces in cells.
  • Apply the changes to the table to the Jupyter notebook.

Miscellaneous improvements and fixes to the file format table
- Avoid adding an additional column and link to the format documentation
  using the names.
- Fix the DICOM format extension: leave it to `none` and add a note
  about its most typical extension (`.dcm`).
- Remove the unnecessary `nii.gz` and `mgh.gz` file extensions: add a
  note about cases where files have been compressed using an third-party
  tool (e.g. gzip).
- Do not use third-party links for the NIfTI format: use the official
  NIfTI format webiste for its link.
- Redirect to the DICOM format documentation instead of the general
  DICOM standard landing page.
- Add Gordon Kindlmann as the origin/creator of the `NRRD` format.
- Remove unnecessary whitespaces in cells.
- Apply the changes to the table to the Jupyter notebook.
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

github-actions bot commented Dec 21, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries-incubator/SDC-BIDS-IntroMRI/compare/md-outputs..md-outputs-PR-55

The following changes were observed in the rendered markdown documents:

 md5sum.txt             |  2 +-
 scanner-to-computer.md | 22 ++++++++++++----------
 2 files changed, 13 insertions(+), 11 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-12-21 00:04:45 +0000

github-actions bot pushed a commit that referenced this pull request Dec 21, 2024
@jhlegarreta jhlegarreta mentioned this pull request Dec 21, 2024
@jhlegarreta jhlegarreta merged commit 3c16073 into carpentries-incubator:main Dec 21, 2024
3 checks passed
@jhlegarreta jhlegarreta deleted the MiscFileFormatTableFixes branch December 21, 2024 00:06
github-actions bot pushed a commit that referenced this pull request Dec 21, 2024
Auto-generated via `{sandpaper}`
Source  : 3c16073
Branch  : main
Author  : Jon Haitz Legarreta Gorroño <[email protected]>
Time    : 2024-12-21 00:06:41 +0000
Message : Merge pull request #55 from jhlegarreta/MiscFileFormatTableFixes

DOC: Miscellaneous improvements and fixes to the file format table
github-actions bot pushed a commit that referenced this pull request Dec 21, 2024
Auto-generated via `{sandpaper}`
Source  : 09f89fe
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-12-21 00:07:19 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 3c16073
Branch  : main
Author  : Jon Haitz Legarreta Gorroño <[email protected]>
Time    : 2024-12-21 00:06:41 +0000
Message : Merge pull request #55 from jhlegarreta/MiscFileFormatTableFixes

DOC: Miscellaneous improvements and fixes to the file format table
github-actions bot pushed a commit that referenced this pull request Dec 24, 2024
Auto-generated via `{sandpaper}`
Source  : 09f89fe
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-12-21 00:07:19 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 3c16073
Branch  : main
Author  : Jon Haitz Legarreta Gorroño <[email protected]>
Time    : 2024-12-21 00:06:41 +0000
Message : Merge pull request #55 from jhlegarreta/MiscFileFormatTableFixes

DOC: Miscellaneous improvements and fixes to the file format table
github-actions bot pushed a commit that referenced this pull request Dec 31, 2024
Auto-generated via `{sandpaper}`
Source  : 09f89fe
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-12-21 00:07:19 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 3c16073
Branch  : main
Author  : Jon Haitz Legarreta Gorroño <[email protected]>
Time    : 2024-12-21 00:06:41 +0000
Message : Merge pull request #55 from jhlegarreta/MiscFileFormatTableFixes

DOC: Miscellaneous improvements and fixes to the file format table
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.

1 participant