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] Error in docstring for nilearn.glm.first_level.first_level_from_bids #4342

Closed
1 task done
michellewang opened this issue Mar 26, 2024 · 1 comment · Fixed by #4352
Closed
1 task done

[DOC] Error in docstring for nilearn.glm.first_level.first_level_from_bids #4342

michellewang opened this issue Mar 26, 2024 · 1 comment · Fixed by #4352
Labels
Documentation for documentation related questions or requests

Comments

@michellewang
Copy link
Contributor

michellewang commented Mar 26, 2024

Is there an existing issue for this?

  • I have searched the existing issues

Describe your proposed suggestion in detail.

The autodocs for nilearn.glm.first_level.first_level_from_bids say to use kwargs prefixed with confound_, which will be passed to nilearn.interfaces.fmriprep.load_confounds, but that is incorrect as it should be confounds_ (plural). Also:

  1. No error is raised if the wrong prefix is used (and it is unclear what happens to kwargs not starting with confounds)
  2. The rendering of some parts of the docstring does not look good (see screenshot below)
Screenshot 2024-03-26 at 2 48 36 PM

List any pages that would be impacted.

https://nilearn.github.io/dev/modules/generated/nilearn.interfaces.fmriprep.load_confounds.html

@michellewang michellewang added the Documentation for documentation related questions or requests label Mar 26, 2024
@bthirion
Copy link
Member

Thx for opening. I'm pretty sure you can fix it ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation for documentation related questions or requests
Projects
None yet
2 participants