Title
Nilearn docathon
Short description and the goals for the OHBM BrainHack
During this BrainHack we would like to spend a bit of time
improving the Nilearn documentation.
-
A lot of the documentation of our functions and classes does not provide short examples on how to use them:
users have to read our (sometimes very long) example to figure out how to use them,
when sometimes all they need is a code snippet: we therefore want to spend some time making sure
that the API reference of our most common function show how they should be used.
-
Several of our examples could benefit from improvements: small incremental updates to the examples may have affected their overall 'flow' and they could benefit from some cleaning and rewriting. We are also considering changing some of the data we use in our examples to make their results more convincing.
Additionally some examples are not really compelling in terms of performance. Replacing them by another one that works better would make them more compelling.
e.g. https://nilearn.github.io/stable/auto_examples/02_decoding/plot_mixed_gambles_frem.html#sphx-glr-auto-examples-02-decoding-plot-mixed-gambles-frem-py
If we have time and if you are interested, you can also join us to discuss in which direction we should take the rewrite of our user-guide (see nilearn/nilearn#3379)
Link to the Project
https://github.com/nilearn/nilearn
Image/Logo for the OHBM brainhack website
https://github.com/nilearn/nilearn/blob/main/doc/logos/nilearn-logo.png
Project lead
Remi Gau, https://github.com/Remi-Gau, Remi-Gau
Main Hub
Bordeaux
Link to the Project pitch
No response
Other hubs covered by the leaders
Skills
Recommended tutorials for new contributors
https://nilearn.github.io/dev/auto_examples/index.html
Good first issues
Other good first issue or documentation related issues
Twitter summary
No response
Short name for the Discord chat channel (~15 chars)
Nilearn doc
Please read and follow the OHBM Code of Conduct
Title
Nilearn docathon
Short description and the goals for the OHBM BrainHack
During this BrainHack we would like to spend a bit of time
improving the Nilearn documentation.
A lot of the documentation of our functions and classes does not provide short examples on how to use them:
users have to read our (sometimes very long) example to figure out how to use them,
when sometimes all they need is a code snippet: we therefore want to spend some time making sure
that the API reference of our most common function show how they should be used.
Several of our examples could benefit from improvements: small incremental updates to the examples may have affected their overall 'flow' and they could benefit from some cleaning and rewriting. We are also considering changing some of the data we use in our examples to make their results more convincing.
Additionally some examples are not really compelling in terms of performance. Replacing them by another one that works better would make them more compelling.
e.g. https://nilearn.github.io/stable/auto_examples/02_decoding/plot_mixed_gambles_frem.html#sphx-glr-auto-examples-02-decoding-plot-mixed-gambles-frem-py
If we have time and if you are interested, you can also join us to discuss in which direction we should take the rewrite of our user-guide (see nilearn/nilearn#3379)
Link to the Project
https://github.com/nilearn/nilearn
Image/Logo for the OHBM brainhack website
https://github.com/nilearn/nilearn/blob/main/doc/logos/nilearn-logo.png
Project lead
Remi Gau, https://github.com/Remi-Gau, Remi-Gau
Main Hub
Bordeaux
Link to the Project pitch
No response
Other hubs covered by the leaders
Skills
Recommended tutorials for new contributors
https://nilearn.github.io/dev/auto_examples/index.html
Good first issues
Other good first issue or documentation related issues
Twitter summary
No response
Short name for the Discord chat channel (~15 chars)
Nilearn doc
Please read and follow the OHBM Code of Conduct