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

[STY] Minor doc formatting #4072

Merged
merged 2 commits into from Oct 20, 2023
Merged

[STY] Minor doc formatting #4072

merged 2 commits into from Oct 20, 2023

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Oct 19, 2023

Changes proposed in this pull request:

  • unindent some code blocks
  • remove extra backticks in class attributes doc

Started to solve #4016 and improve visual rendering, also ended up homogenzing Attributes in classes doc string to match numpy styles

@github-actions
Copy link
Contributor

👋 @Remi-Gau Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

  • PR has an interpretable title.
  • PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
  • Code is PEP8-compliant (see our documentation on coding style)
  • Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

  • There is at least one unit test per new function / class (see our documentation on testing)
  • The new feature is demoed in at least one relevant example.

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

@Remi-Gau
Copy link
Collaborator Author

Before:

image

After:

image

@codecov
Copy link

codecov bot commented Oct 19, 2023

Codecov Report

Merging #4072 (e50a05b) into main (9fcc19d) will decrease coverage by 0.10%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4072      +/-   ##
==========================================
- Coverage   91.60%   91.50%   -0.10%     
==========================================
  Files         143      143              
  Lines       16072    16072              
  Branches     3339     3339              
==========================================
- Hits        14722    14707      -15     
- Misses        804      820      +16     
+ Partials      546      545       -1     
Flag Coverage Δ
macos-latest_3.10 91.49% <ø> (ø)
macos-latest_3.11 91.49% <ø> (ø)
macos-latest_3.12 91.49% <ø> (ø)
macos-latest_3.8 91.45% <ø> (ø)
macos-latest_3.9 91.46% <ø> (ø)
ubuntu-latest_3.10 ?
ubuntu-latest_3.11 ?
ubuntu-latest_3.12 91.49% <ø> (ø)
ubuntu-latest_3.8 91.45% <ø> (ø)
ubuntu-latest_3.9 91.46% <ø> (ø)
windows-latest_3.10 91.43% <ø> (ø)
windows-latest_3.11 91.43% <ø> (ø)
windows-latest_3.12 91.43% <ø> (ø)
windows-latest_3.8 91.39% <ø> (ø)
windows-latest_3.9 91.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
nilearn/_utils/docs.py 91.86% <ø> (ø)
nilearn/connectome/connectivity_matrices.py 94.50% <ø> (ø)
nilearn/connectome/group_sparse_cov.py 81.58% <ø> (ø)
nilearn/decoding/decoder.py 96.92% <ø> (ø)
nilearn/decoding/space_net.py 87.32% <ø> (ø)
nilearn/decomposition/_base.py 94.87% <ø> (ø)
nilearn/decomposition/_multi_pca.py 100.00% <ø> (ø)
nilearn/decomposition/canica.py 91.66% <ø> (ø)
nilearn/decomposition/dict_learning.py 89.06% <ø> (ø)
nilearn/plotting/displays/_projectors.py 98.24% <ø> (ø)
... and 4 more

... and 6 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@bthirion bthirion left a comment

Choose a reason for hiding this comment

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

LGTM so far.

@Remi-Gau Remi-Gau marked this pull request as ready for review October 20, 2023 09:55
@Remi-Gau Remi-Gau merged commit 829778b into nilearn:main Oct 20, 2023
32 checks passed
@Remi-Gau Remi-Gau deleted the fix_doc branch October 20, 2023 09:55
Remi-Gau added a commit to Remi-Gau/nilearn that referenced this pull request Oct 24, 2023
* tidy doc

* more attributes fix
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.

have to use noqa to pacify flake8 when blacken docs reformats long lines
2 participants