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] run style checks on doc #4818

Merged
merged 5 commits into from
Dec 3, 2024
Merged

[STY] run style checks on doc #4818

merged 5 commits into from
Dec 3, 2024

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Nov 29, 2024

Changes proposed in this pull request:

  • use https://pypi.org/project/doc8/ to run style checks on rst files
    • enforces a 120 line length: mostly to avoid long lines that make PR review difficult
    • proper naming of code blocks

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.

Copy link

codecov bot commented Nov 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.66%. Comparing base (e1c5514) to head (d66978b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4818   +/-   ##
=======================================
  Coverage   93.66%   93.66%           
=======================================
  Files         136      136           
  Lines       17147    17147           
  Branches     2962     2962           
=======================================
  Hits        16060    16060           
  Misses        577      577           
  Partials      510      510           
Flag Coverage Δ
macos-latest_3.10_test_plotting 93.17% <ø> (ø)
macos-latest_3.11_test_plotting 93.17% <ø> (ø)
macos-latest_3.12_test_plotting 93.17% <ø> (ø)
macos-latest_3.13_test_plotting 93.17% <ø> (ø)
macos-latest_3.9_test_plotting 93.15% <ø> (ø)
ubuntu-latest_3.10_test_plotting 93.17% <ø> (ø)
ubuntu-latest_3.11_test_plotting 93.17% <ø> (ø)
ubuntu-latest_3.12_test_plotting 93.17% <ø> (ø)
ubuntu-latest_3.13_test_plotting 93.17% <ø> (ø)
ubuntu-latest_3.13_test_pre 93.19% <ø> (ø)
ubuntu-latest_3.9_test_min 69.34% <ø> (ø)
ubuntu-latest_3.9_test_plot_min 92.06% <ø> (ø)
ubuntu-latest_3.9_test_plotting 93.15% <ø> (ø)
windows-latest_3.10_test_plotting 93.15% <ø> (ø)
windows-latest_3.11_test_plotting 93.15% <ø> (ø)
windows-latest_3.12_test_plotting 93.15% <ø> (ø)
windows-latest_3.13_test_plotting 93.15% <ø> (ø)
windows-latest_3.9_test_plotting 93.13% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Remi-Gau Remi-Gau marked this pull request as ready for review November 29, 2024 11:22
@Remi-Gau Remi-Gau requested review from man-shu, bthirion and emdupre and removed request for man-shu November 29, 2024 11:22
@Remi-Gau
Copy link
Collaborator Author

wonder if something about this should be mentioned in the contributing doc?

Comment on lines +87 to +91
- repo: https://github.com/PyCQA/doc8
rev: v1.0.0
hooks:
- id: doc8
args: [--config=pyproject.toml, nilearn]
Copy link
Contributor

Choose a reason for hiding this comment

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

So IIUC, would this fix the line violations when committing?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

no doc8 has no auto fix option: you would have to manually fix it

Copy link
Contributor

Choose a reason for hiding this comment

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

I see so it would just throw an error while committing

@Remi-Gau Remi-Gau marked this pull request as draft November 29, 2024 13:37
@Remi-Gau Remi-Gau added the Code quality This issue tackles code quality (code refactoring, PEP8...). label Nov 29, 2024
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

Copy link
Member

@emdupre emdupre left a comment

Choose a reason for hiding this comment

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

LGTM !

@Remi-Gau Remi-Gau marked this pull request as ready for review December 3, 2024 10:10
@Remi-Gau Remi-Gau mentioned this pull request Dec 3, 2024
@Remi-Gau Remi-Gau merged commit a995cb4 into nilearn:main Dec 3, 2024
34 checks passed
@Remi-Gau Remi-Gau deleted the fix/rst branch December 3, 2024 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code quality This issue tackles code quality (code refactoring, PEP8...).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants