Skip to content

Commit

Permalink
fix links and lint
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaehne committed Mar 12, 2024
1 parent eaf1f30 commit 429d1af
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 12 deletions.
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@

intersphinx_mapping = {
"dask": ("https://docs.dask.org/en/latest", None),
"exspy": ("https://hyperspy.org/exspy", None),
"hyperspy": ("https://hyperspy.org/hyperspy-doc/current/", None),
"kikuchipy": ("https://kikuchipy.org/en/latest/", None),
"matplotlib": ("https://matplotlib.org/stable", None),
Expand Down
2 changes: 1 addition & 1 deletion doc/user_guide/electron_holography.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ hologram should be provided to the method either as Hyperspy's
Using the reconstructed wave, one can access its amplitude and phase (also
unwrapped phase) using
``amplitude`` and ``phase`` properties
(also the :external+hyperspy:py:meth:`hyperspy._signals.complex_signal.ComplexSignal.unwrapped_phase`
(also the :external+hyperspy:meth:`hyperspy.api.signals.ComplexSignal.unwrapped_phase`
method):

.. code-block:: python
Expand Down
17 changes: 8 additions & 9 deletions doc/user_guide/metadata_structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ HoloSpy metadata structure
HoloSpy extends the :external+hyperspy:ref:`HyperSpy metadata structure
<metadata_structure>`
with conventions for metadata specific to its signal types. Refer to the
:external+hyperspy:doc:`HyperSpy metadata documentation <user_guide/metadata_structure>`
:external+hyperspy:ref:`HyperSpy metadata documentation <metadata_structure>`
for general metadata fields.

The metadata of any **signal objects** is stored in the `metadata` attribute,
Expand Down Expand Up @@ -49,14 +49,14 @@ all types of leaves will apply to every type of measurement.
General
=======

See `HyperSpy-Metadata-General
<https://hyperspy.org/hyperspy-doc/current/user_guide/metadata_structure.html#general>`_.
See :external+hyperspy:ref:`HyperSpy-Metadata-General
<general-metadata>`.

Sample
======

See `HyperSpy-Metadata-Sample
<https://hyperspy.org/hyperspy-doc/current/user_guide/metadata_structure.html#sample>`_.
See :external+hyperspy:ref:`HyperSpy-Metadata-Sample
<sample-metadata>`.

Signal
======
Expand All @@ -67,9 +67,8 @@ signal_type
String that describes the type of signal. Currently, the only HoloSpy
specific signal class is ``hologram``.

See `HyperSpy-Metadata-Signal
<https://hyperspy.org/hyperspy-doc/current/user_guide/metadata_structure.html#signal>`__
for additional fields.
See :external+hyperspy:ref:`HyperSpy-Metadata-Signal <signal-metadata>`for

Check warning on line 70 in doc/user_guide/metadata_structure.rst

View workflow job for this annotation

GitHub Actions / Build / Check links and make PR comments

Inline interpreted text or phrase reference start-string without end-string.
additional fields.

Acquisition Instrument
======================
Expand Down Expand Up @@ -98,5 +97,5 @@ voltage

Voltage of electrostatic biprism in volts

See `HyperSpy-Metadata-TEM <https://hyperspy.org/hyperspy-doc/current/user_guide/metadata_structure.html#tem>`_
See :external+exspy:ref:`eXSpy TEM metadata <source-metadata>`
for additional fields.
2 changes: 0 additions & 2 deletions holospy/signals/hologram_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,6 @@ def _estimate_fringe_contrast_statistical(holo):


class HologramImage(Signal2D):

"""Signal class for holograms acquired via off-axis electron holography."""

_signal_type = "hologram"
Expand Down Expand Up @@ -937,7 +936,6 @@ def statistics(


class LazyHologramImage(LazySignal, HologramImage):

"""
Lazy signal class for holograms acquired via off-axis electron
holography.
Expand Down

0 comments on commit 429d1af

Please sign in to comment.