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] First pass on adding cross-refence links surface module #3857

Merged
merged 8 commits into from Jul 23, 2023

Conversation

htwangtw
Copy link
Member

Closes #3844.

Changes proposed in this pull request:

  • Add cross-refence links

I didn't read the original PR title closely, so I edited everything.....

@github-actions
Copy link
Contributor

github-actions bot commented Jul 20, 2023

👋 @htwangtw 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 Jul 20, 2023

Codecov Report

Merging #3857 (4bc0ef4) into main (e002d24) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3857   +/-   ##
=======================================
  Coverage   91.59%   91.59%           
=======================================
  Files         134      134           
  Lines       15694    15698    +4     
  Branches     3270     3270           
=======================================
+ Hits        14375    14379    +4     
  Misses        770      770           
  Partials      549      549           
Flag Coverage Δ
macos-latest_3.10 91.52% <ø> (+<0.01%) ⬆️
macos-latest_3.11 91.52% <ø> (+<0.01%) ⬆️
macos-latest_3.8 91.48% <ø> (+<0.01%) ⬆️
macos-latest_3.9 91.48% <ø> (+<0.01%) ⬆️
ubuntu-latest_3.10 91.52% <ø> (+<0.01%) ⬆️
ubuntu-latest_3.11 91.52% <ø> (+<0.01%) ⬆️
ubuntu-latest_3.8 91.48% <ø> (+<0.01%) ⬆️
ubuntu-latest_3.9 91.48% <ø> (+<0.01%) ⬆️
windows-latest_3.10 91.46% <ø> (+<0.01%) ⬆️
windows-latest_3.11 91.46% <ø> (+<0.01%) ⬆️
windows-latest_3.8 91.42% <ø> (+<0.01%) ⬆️
windows-latest_3.9 91.42% <ø> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
nilearn/surface/surface.py 96.53% <ø> (ø)

... and 2 files with indirect coverage changes

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

nilearn/surface/surface.py Outdated Show resolved Hide resolved
nilearn/surface/surface.py Outdated Show resolved Hide resolved
@htwangtw htwangtw marked this pull request as ready for review July 20, 2023 18:12
nilearn/surface/surface.py Outdated Show resolved Hide resolved
@Remi-Gau Remi-Gau changed the title First pass on adding cross-refence links surface module [DOC] First pass on adding cross-refence links surface module Jul 21, 2023
nilearn/surface/surface.py Outdated Show resolved Hide resolved
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.

Thx @htwangtw ! I think we can merge once the tests pass

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 4a3023f into nilearn:main Jul 23, 2023
29 checks passed
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] Add cross-reference links to type definitions in public surface functions
3 participants