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

add note for check orientation #211

Merged
merged 1 commit into from
Jun 26, 2024
Merged

Conversation

alessandrofelder
Copy link
Member

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

The camera position resulting from the brainreg orientation check in napari was undocumented.

What does this PR do?

Adds a note about the camera position to the check_orientation docs, especially important for asymmetric cases.

References

Closes #210

How has this PR been tested?

Please explain how any new code has been tested, and how you have ensured that no existing functionality has changed.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

\

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality (unit & integration)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@alessandrofelder alessandrofelder marked this pull request as ready for review June 26, 2024 08:51
Copy link
Member

@IgorTatarnikov IgorTatarnikov left a comment

Choose a reason for hiding this comment

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

Seems clear to me 👍

@IgorTatarnikov IgorTatarnikov merged commit a24cb27 into main Jun 26, 2024
3 checks passed
@adamltyson adamltyson deleted the note-check-orientation branch August 2, 2024 09:28
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.

[Feature] Improve docs for check_orientation
2 participants