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.

Sign up for GitHub

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

Jump to bottom

[DOC] Use code cell syntax for splitting blocks in 01_plotting examples #4000

Merged
merged 3 commits into from Sep 22, 2023
Merged

[DOC] Use code cell syntax for splitting blocks in 01_plotting examples #4000

merged 3 commits into from Sep 22, 2023

Conversation

ymzayek
Copy link
Member

@ymzayek ymzayek commented Sep 21, 2023 •
edited

Part of #3937

TODO:

  • Review build docs before merging

@github-actions
Copy link
Contributor

👋 @ymzayek 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 21, 2023 •
edited

Codecov Report

Merging #4000 (7461600) into main (6044428) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4000   +/-   ##
=======================================
  Coverage   91.77%   91.77%           
=======================================
  Files         134      134           
  Lines       15786    15786           
  Branches     3291     3291           
=======================================
  Hits        14487    14487           
  Misses        755      755           
  Partials      544      544
Flag Coverage Δ
macos-latest_3.10 91.68% <ø> (ø)
macos-latest_3.11 91.68% <ø> (ø)
macos-latest_3.8 91.64% <ø> (ø)
macos-latest_3.9 91.65% <ø> (ø)
ubuntu-latest_3.10 91.68% <ø> (ø)
ubuntu-latest_3.11 91.68% <ø> (ø)
ubuntu-latest_3.8 91.64% <ø> (ø)
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.59% <ø> (ø)

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

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

ymzayek
ymzayek commented Sep 21, 2023
View reviewed changes
examples/01_plotting/plot_demo_plotting.py
Comment on lines +52 to +60
# It's also possible to visualize volumes in a LR-flipped "radiological" view
# Just set radiological=True
plotting.plot_stat_map(
stat_img,
threshold=3,
title="plot_stat_map",
cut_coords=[36, -27, 66],
radiological=True,
)
Copy link
Member Author

Choose a reason for hiding this comment

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

Not really related to this PR but this is just moving this plot from the bottom of this example to here as it makes more sense to compare directly with the same plot above it but in radiological view

ymzayek
ymzayek commented Sep 21, 2023
View reviewed changes
examples/01_plotting/plot_demo_glass_brain_extensive.py
Comment on lines 83 to 88
# Setting ``plot_abs=True`` and ``display_mode='yx'`` (returns a
# :class:`~nilearn.plotting.displays.YXProjector`).

plot_glass_brain(
stat_img, threshold=3, colorbar=True, plot_abs=False, display_mode="yx"
stat_img, threshold=3, colorbar=True, plot_abs=True, display_mode="yx"
)
Copy link
Member Author

Choose a reason for hiding this comment

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

Changed to be consistent with the comment

@Remi-Gau
Copy link
Collaborator

LGTM so far.

@ymzayek
Copy link
Member Author

ymzayek commented Sep 21, 2023

I've checked the relevant examples here: https://output.circle-artifacts.com/output/job/b5d329f1-8ec1-4f2b-85ab-0439ec66af68/artifacts/0/dev/auto_examples/01_plotting/index.html

Should be good to go

Remi-Gau
Remi-Gau approved these changes Sep 21, 2023
View reviewed changes
Copy link
Collaborator

@Remi-Gau Remi-Gau left a comment

Choose a reason for hiding this comment

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

Let's Gamble. Try Merging. (LGTM)

bthirion
bthirion approved these changes Sep 21, 2023
View reviewed changes
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.

@ymzayek ymzayek merged commit 975971d into nilearn:main Sep 22, 2023
29 checks passed
@ymzayek ymzayek deleted the 01example-blocks branch December 15, 2023 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bthirion bthirion bthirion approved these changes

@Remi-Gau Remi-Gau Remi-Gau approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@ymzayek @Remi-Gau @bthirion