Skip to content

DOC: Clarify iter_structures return type - #1530

Open
sapunyangkut wants to merge 1 commit into
nipy:masterfrom
sapunyangkut:codex/issue-1440-iter-structures-doc
Open

DOC: Clarify iter_structures return type#1530
sapunyangkut wants to merge 1 commit into
nipy:masterfrom
sapunyangkut:codex/issue-1440-iter-structures-doc

Conversation

@sapunyangkut

Copy link
Copy Markdown

Summary

  • Clarify that the third value yielded by BrainModelAxis.iter_structures() is a BrainModelAxis covering the selected brain structure.

Closes #1440.

Validation

  • python -m pytest nibabel/cifti2/tests/test_axes.py -q (7 passed)
  • python -m pytest nibabel/cifti2/tests -q (110 passed, 16 skipped, 1 xfailed)
  • Ruff check and format check
  • codespell
  • git diff --check

AI assistance

AI assistance was used to screen the issue, prepare the wording change, and review the patch. I verified the implementation, repository guidance, current issue and pull-request state, and all validation results listed above.

@codecov

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.48%. Comparing base (4704d90) to head (1fbd2fb).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1530   +/-   ##
=======================================
  Coverage   95.48%   95.48%           
=======================================
  Files         209      209           
  Lines       30050    30050           
  Branches     4494     4494           
=======================================
  Hits        28692    28692           
  Misses        926      926           
  Partials      432      432           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sapunyangkut
sapunyangkut marked this pull request as ready for review July 18, 2026 10:21
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.

cifti2.cifti2_axes.BrainModelAxis.iter_structures function behavior differs from documentation

1 participant