orientation: expose create_north_up_east_left/right

[kecnry]

Description

This pull request exposes create_north_up_east_left(...) and create_north_up_east_right(...) methods via the public API of the Orientation plugin, along with API hints.

This also renames set_on_create to set_as_orientation in these methods, as it sets them whether or not they are created. This does not however, rename the already public set_on_create within add_orientation(...)

Docs updates: Orientation plugin API docs

API hints:

Change log entry

• Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
  list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
  should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

• Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
• Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
• Do the proposed changes follow the STScI Style Guides?
• Are tests added/updated as required? If so, do they follow the STScI Style Guides?
• Are docs added/updated as required? If so, do they follow the STScI Style Guides?
• Did the CI pass? If not, are the failures related?
• Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
• After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

[kecnry]

should we remove create_ from the method names since these can create AND/OR set?

[bmorris3]

I might vote for set_ rather than create_, since set_ tells you the end result?

[kecnry]

unless you pass set_as_orientation = False 🤔... but I think I agree that I still prefer that

[codecov]

Codecov Report

Attention: Patch coverage is 63.63636% with 4 lines in your changes missing coverage. Please review.

Project coverage is 88.81%. Comparing base (7e5ddfa) to head (2381f25).
Report is 10 commits behind head on main.

Files with missing lines	Patch %	Lines
...z/configs/imviz/plugins/orientation/orientation.py	63.63%	4 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3308   +/-   ##
=======================================
  Coverage   88.81%   88.81%           
=======================================
  Files         125      125           
  Lines       19030    19041   +11     
=======================================
+ Hits        16901    16911   +10     
- Misses       2129     2130    +1     

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

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[camipacifici]

Clear, works well for me.

[bmorris3]

This looks great, thanks @kecnry!

[bmorris3]

Suggested change

	# defined as traitlet to allow access from UI - leave fixed
	# defined as traitlet to allow access from UI - leave fixed
	# since this name is used to identify WCS-only layers elsewhere in jdaviz.

[kecnry]

I replaced the comment with: defined as traitlet in addition to global variable above to allow access from UI - leave fixed to give more context. Maybe we should define this in one place and import into others if it is an assumed fixed string, but we can do that later 🤷‍♂️

[kecnry]

@bmorris3 @camipacifici - I renamed create_north_up_east_left/right to set_north_up_east_left/right and also removed the set_as_orientation option from the public API... I don't see a reason why a user would want to create but not set the orientation and I think it only adds confusion, but if either of you want me to keep it, let me know and I'll revert that change.

[camipacifici]

You are right, I am ok with that.