Skip to content

Commit

Permalink
Update various docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
KelSolaar committed Jan 25, 2025
1 parent ee4a1b2 commit 8e66ed5
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 24 deletions.
4 changes: 2 additions & 2 deletions colour/algebra/extrapolation.py
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ def left(self) -> Real | None:
Returns
-------
:py:data:`None` or Real
Real or :py:data:`None`
Left value to return for x < xi[0].
"""

Expand Down Expand Up @@ -272,7 +272,7 @@ def right(self) -> Real | None:
Returns
-------
:py:data:`None` or Real
Real or :py:data:`None`
Right value to return for x > xi[-1].
"""

Expand Down
34 changes: 17 additions & 17 deletions colour/io/tm2714.py
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ def manufacturer(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Manufacturer.
"""

Expand Down Expand Up @@ -287,7 +287,7 @@ def catalog_number(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Catalog number.
"""

Expand Down Expand Up @@ -317,7 +317,7 @@ def description(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Description.
"""

Expand Down Expand Up @@ -347,7 +347,7 @@ def document_creator(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Document creator.
"""

Expand Down Expand Up @@ -377,7 +377,7 @@ def unique_identifier(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Unique identifier.
"""

Expand Down Expand Up @@ -407,7 +407,7 @@ def measurement_equipment(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Measurement equipment.
"""

Expand Down Expand Up @@ -437,7 +437,7 @@ def laboratory(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Laboratory.
"""

Expand Down Expand Up @@ -467,7 +467,7 @@ def report_number(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Report number.
"""

Expand Down Expand Up @@ -497,7 +497,7 @@ def report_date(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Report date.
"""

Expand Down Expand Up @@ -527,7 +527,7 @@ def document_creation_date(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Document creation date.
"""

Expand Down Expand Up @@ -557,7 +557,7 @@ def comments(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Comments.
"""

Expand Down Expand Up @@ -1025,7 +1025,7 @@ def path(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Path.
"""

Expand Down Expand Up @@ -1104,7 +1104,7 @@ def spectral_quantity(
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Spectral quantity.
"""

Expand Down Expand Up @@ -1171,7 +1171,7 @@ def reflection_geometry(
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Reflection geometry.
"""

Expand Down Expand Up @@ -1222,7 +1222,7 @@ def transmission_geometry(
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Transmission geometry.
"""

Expand Down Expand Up @@ -1255,7 +1255,7 @@ def bandwidth_FWHM(self) -> float | None:
Returns
-------
:py:data:`None` or :class:`float`
:class:`float` or :py:data:`None`
Full-width half-maximum bandwidth.
"""

Expand Down Expand Up @@ -1288,7 +1288,7 @@ def bandwidth_corrected(self) -> bool | None:
Returns
-------
:py:data:`None` or :class:`bool`
:class:`bool` or :py:data:`None`
Whether bandwidth correction has been applied to the measured data.
"""

Expand Down
6 changes: 3 additions & 3 deletions colour/models/rgb/rgb_colourspace.py
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ def whitepoint_name(self) -> str | None:
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
*RGB* colourspace whitepoint name.
"""

Expand Down Expand Up @@ -506,7 +506,7 @@ def cctf_encoding(self) -> Callable | None:
Returns
-------
:py:data:`None` or Callable
Callable or :py:data:`None`
Encoding colour component transfer function (Encoding CCTF) /
opto-electronic transfer function (OETF).
"""
Expand Down Expand Up @@ -540,7 +540,7 @@ def cctf_decoding(self) -> Callable | None:
Returns
-------
:py:data:`None` or Callable
Callable or :py:data:`None`
Decoding colour component transfer function (Decoding CCTF) /
electro-optical transfer function (EOTF).
"""
Expand Down
2 changes: 1 addition & 1 deletion colour/notation/munsell.py
Original file line number Diff line number Diff line change
Expand Up @@ -2007,7 +2007,7 @@ def interpolation_method_from_renotation_ovoid(
Returns
-------
:py:data:`None` or :class:`str`
:class:`str` or :py:data:`None`
Interpolation method.
References
Expand Down
2 changes: 1 addition & 1 deletion colour/recovery/otsu2018.py
Original file line number Diff line number Diff line change
Expand Up @@ -768,7 +768,7 @@ def mean(self) -> NDArrayFloat | None:
Returns
-------
:py:data:`None` or :class:`numpy.ndarray`
:class:`numpy.ndarray` or :py:data:`None`
Mean distribution.
"""

Expand Down

0 comments on commit 8e66ed5

Please sign in to comment.