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

[DOC] link surface terms to glossary #4161

Merged
merged 5 commits into from Dec 20, 2023
Merged

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Dec 13, 2023

Changes proposed in this pull request:

  • add surface related terms to glossary (vertex, face, mesh) and links them in doc and codebase

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 Dec 13, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9362f97) 91.84% compared to head (9f0baa6) 91.93%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4161      +/-   ##
==========================================
+ Coverage   91.84%   91.93%   +0.09%     
==========================================
  Files         145      145              
  Lines       16337    16360      +23     
  Branches     3407     3424      +17     
==========================================
+ Hits        15004    15040      +36     
+ Misses        792      777      -15     
- Partials      541      543       +2     
Flag Coverage Δ
macos-latest_3.10_test_plotting 91.71% <ø> (+0.01%) ⬆️
macos-latest_3.11_test_plotting 91.71% <ø> (+0.01%) ⬆️
macos-latest_3.12_test_plotting 91.71% <ø> (+0.01%) ⬆️
macos-latest_3.8_test_plotting 91.67% <ø> (+0.01%) ⬆️
macos-latest_3.9_test_plotting 91.67% <ø> (+0.01%) ⬆️
ubuntu-latest_3.10_test_plotting 91.71% <ø> (+0.01%) ⬆️
ubuntu-latest_3.11_test_plotting 91.71% <ø> (+0.01%) ⬆️
ubuntu-latest_3.12_test_plotting 91.71% <ø> (+0.01%) ⬆️
ubuntu-latest_3.12_test_pre 91.71% <ø> (+0.01%) ⬆️
ubuntu-latest_3.8_test_min 68.90% <ø> (?)
ubuntu-latest_3.8_test_plot_min 91.43% <ø> (+0.01%) ⬆️
ubuntu-latest_3.8_test_plotting 91.67% <ø> (+0.01%) ⬆️
ubuntu-latest_3.9_test_plotting 91.67% <ø> (+0.01%) ⬆️
windows-latest_3.10_test_plotting 91.68% <ø> (+0.01%) ⬆️
windows-latest_3.11_test_plotting 91.68% <ø> (+0.01%) ⬆️
windows-latest_3.12_test_plotting 91.68% <ø> (+0.01%) ⬆️
windows-latest_3.8_test_plotting 91.64% <ø> (+0.01%) ⬆️
windows-latest_3.9_test_plotting 91.65% <ø> (+0.01%) ⬆️

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 changed the title link surface terms to glossary [DOC] link surface terms to glossary Dec 13, 2023
Copy link
Member

@ymzayek ymzayek left a comment

Choose a reason for hiding this comment

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

Thank @Remi-Gau !
I wonder if we should add 'texture'? It's not used a lot in the docs but more so as a variable name when it equals an array projected on the surface

doc/glossary.rst Outdated Show resolved Hide resolved
nilearn/experimental/surface/_surface_image.py Outdated Show resolved Hide resolved
doc/sg_execution_times.rst Outdated Show resolved Hide resolved
Co-authored-by: Yasmin <63292494+ymzayek@users.noreply.github.com>
@Remi-Gau
Copy link
Collaborator Author

Thank @Remi-Gau ! I wonder if we should add 'texture'? It's not used a lot in the docs but more so as a variable name when it equals an array projected on the surface

yes definitely

I had listed also:

  • coordinates
  • geometry

But they feel too generic, no?

@Remi-Gau
Copy link
Collaborator Author

if we should add 'texture'?

Only mentioned once: nilearn/examples/01_plotting/plot_3d_map_to_surface_projection.py:53

So maybe not?

@bthirion
Copy link
Member

No strong opinion on "textures". We could also use it more frequently...

@Remi-Gau Remi-Gau marked this pull request as ready for review December 15, 2023 14:35
@Remi-Gau
Copy link
Collaborator Author

Would suggest to merge this as is and add texture later

@bthirion
Copy link
Member

Good with me.

@Remi-Gau Remi-Gau merged commit 3a4355a into nilearn:main Dec 20, 2023
32 checks passed
@Remi-Gau Remi-Gau deleted the term_surf branch December 21, 2023 09:57
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.

[DOC] improve surface related documentation
3 participants