Skip to content

Commit

Permalink
Fix some internal API reference links
Browse files Browse the repository at this point in the history
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
  • Loading branch information
hakonanes committed Nov 9, 2024
1 parent 52346c1 commit c6602b6
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 14 deletions.
3 changes: 1 addition & 2 deletions src/kikuchipy/data/_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -353,8 +353,7 @@ def si_wafer(
See Also
--------
silicon_ebsd_moving_screen_in, silicon_ebsd_moving_screen_out5mm,
silicon_ebsd_moving_screen_out10mm
silicon_ebsd_moving_screen
Notes
-----
Expand Down
2 changes: 1 addition & 1 deletion src/kikuchipy/detectors/ebsd_detector.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ class EBSDDetector:
x_B^* &= x_T^*,\\
y_B^* &= 1 - y_T^*,\\
z_B^* &= \frac{min(N_x, N_y)}{N_y} z_T^*.
z_B^* &= \frac{\min(N_x, N_y)}{N_y} z_T^*.
The conversion from Oxford Instruments to Bruker is given as
Expand Down
18 changes: 7 additions & 11 deletions src/kikuchipy/signals/ebsd.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,15 +123,15 @@ class EBSD(KikuchipySignal2D):
----------
*args
See :class:`~hyperspy._signals.signal2d.Signal2D`.
detector : EBSDDetector, optional
detector : :class:`~kikuchipy.detectors.EBSDDetector`, optional
Detector describing the EBSD detector-sample geometry. If not
given, this is a default detector (see :class:`EBSDDetector`).
static_background : ~numpy.ndarray or ~dask.array.Array, optional
Static background pattern. If not given, this is ``None``.
given, this is a default detector.
static_background : numpy.ndarray or dask.array.Array, optional
Static background pattern. If not given, this is None.
xmap : ~orix.crystal_map.CrystalMap
Crystal map containing the phases, unit cell rotations and
auxiliary properties of the EBSD dataset. If not given, this is
``None``.
None.
**kwargs
See :class:`~hyperspy._signals.signal2d.Signal2D`.
Expand All @@ -141,12 +141,8 @@ class EBSD(KikuchipySignal2D):
An EBSD signal with ``(3, 3)`` experimental nickel patterns.
kikuchipy.data.nickel_ebsd_large :
An EBSD signal with ``(55, 75)`` experimental nickel patterns.
kikuchipy.data.silicon_ebsd_moving_screen_in :
An EBSD signal with one experimental silicon pattern.
kikuchipy.data.silicon_ebsd_moving_screen_out5mm :
An EBSD signal with one experimental silicon pattern.
kikuchipy.data.silicon_ebsd_moving_screen_out10mm :
An EBSD signal with one experimental silicon pattern.
kikuchipy.data.si_ebsd_moving_screen :
An EBSD signal with experimental silicon patterns.
Examples
--------
Expand Down

0 comments on commit c6602b6

Please sign in to comment.