Skip to content

High-pass instead of low-pass, fix typo - #1

Open
utooley wants to merge 1 commit into
nistats:masterfrom
utooley:patch-1
Open

High-pass instead of low-pass, fix typo#1
utooley wants to merge 1 commit into
nistats:masterfrom
utooley:patch-1

Conversation

@utooley

@utooley utooley commented Jun 6, 2019

Copy link
Copy Markdown

To be in accordance with the function documentation for make_first_level_design_matrix.

To be in accordance with the function documentation for make_first_level_design_matrix.
@bthirion

bthirion commented Jun 6, 2019

Copy link
Copy Markdown
Contributor

Thx ! It is really nice to take care of these details, but html pages are generated by sphinx, hence the issue should be fixed in the original Python file. Does thsi make sense ?
Best,
Bertrand

@utooley

utooley commented Jun 7, 2019

Copy link
Copy Markdown
Author

Yes, I thought that was the case! But something is wrong above my level of technical expertise, I think... in the design_matrix.py docs, it is correctly labeled as being a high-pass filter, but that's not propagating to the docs here. Not sure why?

@kchawla-pi

Copy link
Copy Markdown
Member

Hi @utooley Thank you so much for doing this!
I believe the incorrect documentation has been fixed in nilearn/nistats#319 .
However, we don't push out new documentation to the website until next release time, which is why the site is showing old documentation even thouh it has been fixed in nistats/master.
@bthirion Should we do this fix on the current website using this Pull Request? We can merge this change, so the website is corrected. In fact,we can mention here that there is an error in the docstring in Nistats upto v0.1.0b . What do you think?

@utooley

utooley commented Jun 9, 2019

Copy link
Copy Markdown
Author

Got it, that makes sense! Thanks for clarifying @kchawla-pi. I thought it might have been something like that, but it was still a difficult to figure out without digging through the repo code.

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.

3 participants