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

[WIP] apply black to docs #4005

Merged
merged 1 commit into from Sep 28, 2023
Merged

[WIP] apply black to docs #4005

merged 1 commit into from Sep 28, 2023

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Sep 22, 2023

Changes proposed in this pull request:

  • apply black to docs
  • update pre-commit hooks

@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.

@codecov
Copy link

codecov bot commented Sep 22, 2023

Codecov Report

Merging #4005 (ed970bb) into main (3f85e18) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4005   +/-   ##
=======================================
  Coverage   91.77%   91.77%           
=======================================
  Files         134      134           
  Lines       15795    15795           
  Branches     3299     3299           
=======================================
  Hits        14496    14496           
  Misses        755      755           
  Partials      544      544           
Flag Coverage Δ
macos-latest_3.10 91.69% <ø> (ø)
macos-latest_3.11 91.69% <ø> (ø)
macos-latest_3.8 91.65% <ø> (ø)
macos-latest_3.9 91.65% <ø> (ø)
ubuntu-latest_3.10 91.69% <ø> (ø)
ubuntu-latest_3.11 91.69% <ø> (ø)
ubuntu-latest_3.8 91.65% <ø> (ø)
ubuntu-latest_3.9 91.65% <ø> (ø)
windows-latest_3.10 91.63% <ø> (?)
windows-latest_3.11 91.63% <ø> (ø)
windows-latest_3.8 91.59% <ø> (ø)
windows-latest_3.9 91.60% <ø> (ø)

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

Files Changed Coverage Δ
nilearn/_utils/docs.py 91.86% <ø> (ø)
nilearn/datasets/atlas.py 93.14% <ø> (ø)
nilearn/plotting/displays/_projectors.py 98.24% <ø> (ø)
nilearn/plotting/displays/_slicers.py 90.88% <ø> (ø)

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

@Remi-Gau Remi-Gau marked this pull request as ready for review September 23, 2023 08:24

- `logistic_l1`: \
:class:`{logistic} <sklearn.linear_model.LogisticRegressionCV>` \
with L1 penalty.
.. code-block:: python

logistic_l1 = LogisticRegression(penalty="l1",
solver="liblinear")
logistic_l1 = LogisticRegression(penalty="l1", solver="liblinear") # noqa
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Am not happy about having to use a noqa here but without it flake8 complains about line length and blacken docs will reformat any line break.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Will merge and open an issue to remember to find a fix for this minor detail

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, thx.

@Remi-Gau Remi-Gau merged commit 5d7f5c6 into nilearn:main Sep 28, 2023
29 checks passed
@Remi-Gau Remi-Gau deleted the black_docs branch September 28, 2023 08:33
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

2 participants