add note for check orientation - Githubissues

brainglobe / brainglobe.github.io

brainglobe.info website

https://brainglobe.info/

Creative Commons Attribution 4.0 International

10 stars 7 forks source link

add note for check orientation #211

Closed alessandrofelder closed 2 months ago

alessandrofelder commented 2 months ago

Description

What is this PR

[ ] Bug fix
[x] 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