add changelog entry and documentation

jlaehne · Oct 19, 2024 · 7354f6b · 7354f6b
1 parent bfa229b
commit 7354f6b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/doc/dev_guide/writing_extensions.rst b/doc/dev_guide/writing_extensions.rst
@@ -187,6 +187,12 @@ the signal subclass with ``Electron Energy Loss Spectroscopy`` signal type.
 It is good practice to choose a very explicit ``signal_type`` while leaving
 acronyms for ``signal_type_aliases``.
 
+Additionally, the optional key ``hidden: True`` can be defined if a signal should
+be registered with HyperSpy, but not listed by :meth:`hyperspy.api.print_known_signal_types`.
+This option can be used if a signal subclass is needed for certain functionalities,
+such as casting to a different signal subclass, but should usually not be set
+directly by the user.
+
 Creating new HyperSpy model components
 --------------------------------------
 

diff --git a/upcoming_changes/3302.enhancements.rst b/upcoming_changes/3302.enhancements.rst
@@ -0,0 +1 @@
+Allow setting optional ``hidden`` key in definition of signals extending hyperspy, which prevents them from being shown by ``print_known_signal_types()``.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Allow setting optional ``hidden`` key in definition of signals extending hyperspy, which prevents them from being shown by ``print_known_signal_types()``.