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: Add warning about slice timing correction in output documentation. #2502

Merged
merged 11 commits into from
Sep 8, 2021

Conversation

theoschaefer
Copy link
Contributor

Changes proposed in this pull request

Adds warning about slice timing correction in the output documentation.
Addresses issue #2477.

Documentation that should be reviewed

Outputs of fMRIPrep

theoschaefer and others added 4 commits August 10, 2021 18:46
DOC: Add warning about slice timing correction in output documentation with example
Added Alexander Nitsch and Theo Schäfer
@HippocampusGirl
Copy link
Contributor

Would it be a good idea to also add some of that text to the log entry on slice timing?

LOGGER.log(25, 'Slice-timing correction will be included.')

Copy link
Member

@oesteban oesteban left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can make this a "danger" admonition. Also, some suggestions to break lines and add Russ' and Jeanette's blog post link.

.zenodo.json Show resolved Hide resolved
docs/outputs.rst Outdated Show resolved Hide resolved
docs/outputs.rst Outdated Show resolved Hide resolved
@oesteban
Copy link
Member

oesteban commented Sep 1, 2021

Hi @theoschaefer, could you give us an indication of when you can get back to this? Thanks very much!

@oesteban
Copy link
Member

oesteban commented Sep 1, 2021

Would it be a good idea to also add some of that text to the log entry on slice timing?

LOGGER.log(25, 'Slice-timing correction will be included.')

Let's address this on #2520.

Co-authored-by: Oscar Esteban <code@oscaresteban.es>
@theoschaefer
Copy link
Contributor Author

theoschaefer commented Sep 1, 2021

Hi @theoschaefer, could you give us an indication of when you can get back to this? Thanks very much!

Hi @oesteban,
sorry for the late response. Thanks for your comments and corrections! I am still on vacation and will be back on the 6th September. I will then insert all the changes if that is okay :)

@effigies
Copy link
Member

effigies commented Sep 1, 2021

@oesteban This can go in post-rc1.

@theoschaefer
Copy link
Contributor Author

theoschaefer commented Sep 6, 2021

@oesteban We have added our names to the contributors.json file and committed your suggestions for the documentation.
Do we have to undo our changes in the zenodo file?

@oesteban oesteban merged commit a700aa9 into nipreps:master Sep 8, 2021
@oesteban
Copy link
Member

oesteban commented Sep 8, 2021

Thanks much for this contribution, and all the discussion that was very much needed around slice timing correction.

@theoschaefer theoschaefer mentioned this pull request Jan 24, 2022
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.

None yet

5 participants