-
-
Notifications
You must be signed in to change notification settings - Fork 18
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: Update introduction and preprocessing lessons #222
DOC: Update introduction and preprocessing lessons #222
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
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.
Content-wise, this seems good to me.
Should run this through a linter for formatting / consistency with other lessons
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.
A few in-line comments.
The old image should be removed from the repository if it is no longer used.
Do not forget to apply them to the Jupyter Notebook.
Also, please squash all commits into a single one in this case.
@Bradley-Karat would you have time to address the comments or do you prefer to hand it over to somebody else? Thanks. |
1 similar comment
@Bradley-Karat would you have time to address the comments or do you prefer to hand it over to somebody else? Thanks. |
Sorry Jon just saw this now. I can go through and address some of these comments. |
dcf35b5
to
cc06f9a
Compare
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.
Thanks for the effort Bradley. A few notes:
- Can you please add a commit prefix: e.g.
DOC
to signal that this his a documentation commit? Please see the commit history for guidance on this. - We have tried to limit the line length to 79 characters so that reading the raw files is easier and for the sake of consistency. Applies to both the Markdown and Jupyter Notebooks. Although the Markdown and Jupyter Notebook rendering does not get affected by the line length, keeping a moderate and consistent number helps a lot when reviewing.
Also, change the commit subject and message: the preprocessing episode was also changed. |
@Bradley-Karat can you please address the comments made? |
cc06f9a
to
db4baa2
Compare
❌ Deploy Preview for carpentries-dmri failed.
|
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.
Please, add a commit prefix (i.e. DOC:
) and message body to the commit explaining the changes. This is an excellent post on why this matters.
@Bradley-Karat Can the comments above be addressed, please? |
Pinging @Bradley-Karat. |
Added in and expanded upon the current information in the introduction and preprocessing lessons. This includes changes to improve clarity and the logical flow of the lesson. Also changed the first figure of the introduction lesson to something that is a bit more clear (i.e. easier to understand the signal change via gradient direction change).
db4baa2
to
b2e30d0
Compare
❌ Deploy Preview for sdc-bids-dmri failed.
|
Sorry Jon just got to this, just made those changes. |
Thanks for addressing the comments @Bradley-Karat. Usual tests timing out. Merging. |
Added in and expanded upon the current information in the introduction and preprocessing lessons. This includes changes to improve clarity and the logical flow of the lesson. Also changed the first figure of the introduction lesson to something that is a bit more clear (i.e. easier to understand the signal change via gradient direction change).