Update docstrings in colour.temperature package.

Author: KelSolaar

colour/temperature/__init__.py

@@ -144,9 +144,9 @@ def uv_to_CCT(
     **kwargs: Any,
 ) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` and
-    :math:`\\Delta_{uv}` from given *CIE UCS* colourspace *uv* chromaticity
-    coordinates using given method.
+    Compute the correlated colour temperature :math:`T_{cp}` and
+    :math:`\\Delta_{uv}` from specified *CIE UCS* colourspace *uv* chromaticity
+    coordinates using specified method.
 
     Parameters
     ----------
@@ -237,8 +237,8 @@ def CCT_to_uv(
     **kwargs: Any,
 ) -> NDArrayFloat:
     """
-    Return the *CIE UCS* colourspace *uv* chromaticity coordinates from given
-    correlated colour temperature :math:`T_{cp}` using given method.
+    Compute the *CIE UCS* colourspace *uv* chromaticity coordinates from specified
+    correlated colour temperature :math:`T_{cp}` using specified method.
 
     Parameters
     ----------
@@ -332,8 +332,8 @@ def xy_to_CCT(
     ) = "CIE Illuminant D Series",
 ) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` from given
-    *CIE xy* chromaticity coordinates using given method.
+    Compute the correlated colour temperature :math:`T_{cp}` from specified
+    *CIE xy* chromaticity coordinates using specified method.
 
     Parameters
     ----------
@@ -417,8 +417,8 @@ def CCT_to_xy(
     ) = "CIE Illuminant D Series",
 ) -> NDArrayFloat:
     """
-    Return the *CIE xy* chromaticity coordinates from given correlated colour
-    temperature :math:`T_{cp}` using given method.
+    Compute the *CIE xy* chromaticity coordinates from specified correlated colour
+    temperature :math:`T_{cp}` using specified method.
 
     Parameters
     ----------

colour/temperature/cie_d.py

@@ -51,7 +51,7 @@ def xy_to_CCT_CIE_D(
     xy: ArrayLike, optimisation_kwargs: dict | None = None
 ) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` of a
+    Compute the correlated colour temperature :math:`T_{cp}` of a
     *CIE Illuminant D Series* from its *CIE xy* chromaticity coordinates.
 
     Parameters
@@ -122,7 +122,7 @@ def objective_function(CCT: NDArrayFloat, xy: NDArrayFloat) -> DTypeFloat:
 
 def CCT_to_xy_CIE_D(CCT: ArrayLike) -> NDArrayFloat:
     """
-    Return the *CIE xy* chromaticity coordinates of a
+    Compute the *CIE xy* chromaticity coordinates of a
     *CIE Illuminant D Series* from its correlated colour temperature
     :math:`T_{cp}`.
 

colour/temperature/hernandez1999.py

@@ -6,10 +6,10 @@
 :math:`T_{cp}` computations objects:
 
 -   :func:`colour.temperature.xy_to_CCT_Hernandez1999`: Correlated colour
-    temperature :math:`T_{cp}` computation of given *CIE xy* chromaticity
+    temperature :math:`T_{cp}` computation of specified *CIE xy* chromaticity
     coordinates using *Hernandez-Andres, Lee and Romero (1999)* method.
 -   :func:`colour.temperature.CCT_to_xy_Hernandez1999`: *CIE xy* chromaticity
-    coordinates computation of given correlated colour temperature
+    coordinates computation of specified correlated colour temperature
     :math:`T_{cp}` using *Hernandez-Andres, Lee and Romero (1999)* method.
 
 References
@@ -50,7 +50,7 @@
 
 def xy_to_CCT_Hernandez1999(xy: ArrayLike) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` from given
+    Compute the correlated colour temperature :math:`T_{cp}` from specified
     *CIE xy* chromaticity coordinates using *Hernandez-Andres et al. (1999)*
     method.
 
@@ -104,7 +104,7 @@ def CCT_to_xy_Hernandez1999(
     CCT: ArrayLike, optimisation_kwargs: dict | None = None
 ) -> NDArrayFloat:
     """
-    Return the *CIE xy* chromaticity coordinates from given correlated colour
+    Compute the *CIE xy* chromaticity coordinates from specified correlated colour
     temperature :math:`T_{cp}` using *Hernandez-Andres et al. (1999)* method.
 
     Parameters

colour/temperature/kang2002.py

@@ -48,7 +48,7 @@ def xy_to_CCT_Kang2002(
     xy: ArrayLike, optimisation_kwargs: dict | None = None
 ) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` from given
+    Compute the correlated colour temperature :math:`T_{cp}` from specified
     *CIE xy* chromaticity coordinates using *Kang et al. (2002)* method.
 
     Parameters
@@ -119,7 +119,7 @@ def objective_function(CCT: NDArrayFloat, xy: NDArrayFloat) -> DTypeFloat:
 
 def CCT_to_xy_Kang2002(CCT: ArrayLike) -> NDArrayFloat:
     """
-    Return the *CIE xy* chromaticity coordinates from given correlated colour
+    Compute the *CIE xy* chromaticity coordinates from specified correlated colour
     temperature :math:`T_{cp}` using *Kang et al. (2002)* method.
 
     Parameters

colour/temperature/krystek1985.py

@@ -48,7 +48,7 @@ def uv_to_CCT_Krystek1985(
     uv: ArrayLike, optimisation_kwargs: dict | None = None
 ) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` from given
+    Compute the correlated colour temperature :math:`T_{cp}` from specified
     *CIE UCS* colourspace *uv* chromaticity coordinates using *Krystek (1985)*
     method.
 
@@ -125,7 +125,7 @@ def objective_function(CCT: NDArrayFloat, uv: NDArrayFloat) -> DTypeFloat:
 
 def CCT_to_uv_Krystek1985(CCT: ArrayLike) -> NDArrayFloat:
     """
-    Return the *CIE UCS* colourspace *uv* chromaticity coordinates from given
+    Compute the *CIE UCS* colourspace *uv* chromaticity coordinates from specified
     correlated colour temperature :math:`T_{cp}` using *Krystek (1985)* method.
 
     Parameters

colour/temperature/mccamy1992.py

@@ -48,7 +48,7 @@
 
 def xy_to_CCT_McCamy1992(xy: ArrayLike) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` from given
+    Compute the correlated colour temperature :math:`T_{cp}` from specified
     *CIE xy* chromaticity coordinates using *McCamy (1992)* method.
 
     Parameters
@@ -87,7 +87,7 @@ def CCT_to_xy_McCamy1992(
     CCT: ArrayLike, optimisation_kwargs: dict | None = None
 ) -> NDArrayFloat:
     """
-    Return the *CIE xy* chromaticity coordinates from given correlated colour
+    Compute the *CIE xy* chromaticity coordinates from specified correlated colour
     temperature :math:`T_{cp}` using *McCamy (1992)* method.
 
     Parameters

colour/temperature/ohno2013.py

@@ -78,7 +78,7 @@ def planckian_table(
     spacing: float,
 ) -> NDArrayFloat:
     """
-    Return a planckian table from given *CIE UCS* colourspace *uv*
+    Generate a planckian table from specified *CIE UCS* colourspace *uv*
     chromaticity coordinates, colour matching functions and temperature range
     using *Ohno (2013)* method.
 
@@ -153,8 +153,8 @@ def uv_to_CCT_Ohno2013(
     spacing: float | None = None,
 ) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` and
-    :math:`\\Delta_{uv}` from given *CIE UCS* colourspace *uv* chromaticity
+    Compute the correlated colour temperature :math:`T_{cp}` and
+    :math:`\\Delta_{uv}` from specified *CIE UCS* colourspace *uv* chromaticity
     coordinates, colour matching functions and temperature range using
     *Ohno (2013)* method.
 
@@ -279,7 +279,7 @@ def CCT_to_uv_Ohno2013(
     CCT_D_uv: ArrayLike, cmfs: MultiSpectralDistributions | None = None
 ) -> NDArrayFloat:
     """
-    Return the *CIE UCS* colourspace *uv* chromaticity coordinates from given
+    Compute the *CIE UCS* colourspace *uv* chromaticity coordinates from specified
     correlated colour temperature :math:`T_{cp}`, :math:`\\Delta_{uv}` and
     colour matching functions using *Ohno (2013)* method.
 
@@ -345,8 +345,8 @@ def XYZ_to_CCT_Ohno2013(
     spacing: float | None = None,
 ) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` and
-    :math:`\\Delta_{uv}` from given *CIE XYZ* tristimulus values, colour
+    Compute the correlated colour temperature :math:`T_{cp}` and
+    :math:`\\Delta_{uv}` from specified *CIE XYZ* tristimulus values, colour
     matching functions and temperature range using *Ohno (2013)* method.
 
     Parameters
@@ -396,7 +396,7 @@ def CCT_to_XYZ_Ohno2013(
     CCT_D_uv: ArrayLike, cmfs: MultiSpectralDistributions | None = None
 ) -> NDArrayFloat:
     """
-    Return the *CIE XYZ* tristimulus values from given correlated colour
+    Compute the *CIE XYZ* tristimulus values from specified correlated colour
     temperature :math:`T_{cp}`, :math:`\\Delta_{uv}` and colour matching
     functions using *Ohno (2013)* method.
 

colour/temperature/planck1900.py

@@ -54,8 +54,8 @@ def uv_to_CCT_Planck1900(
     optimisation_kwargs: dict | None = None,
 ) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` of a blackbody from
-    given *CIE UCS* colourspace *uv* chromaticity coordinates and colour
+    Compute the correlated colour temperature :math:`T_{cp}` of a blackbody from
+    specified *CIE UCS* colourspace *uv* chromaticity coordinates and colour
     matching functions.
 
     Parameters
@@ -131,9 +131,9 @@ def CCT_to_uv_Planck1900(
     CCT: ArrayLike, cmfs: MultiSpectralDistributions | None = None
 ) -> NDArrayFloat:
     """
-    Return the *CIE UCS* colourspace *uv* chromaticity coordinates from given
+    Compute the *CIE UCS* colourspace *uv* chromaticity coordinates from specified
     correlated colour temperature :math:`T_{cp}` and colour matching functions
-    using the spectral radiance of a blackbody at the given thermodynamic
+    using the spectral radiance of a blackbody at the specified thermodynamic
     temperature.
 
     Parameters

colour/temperature/robertson1968.py

@@ -154,7 +154,7 @@ class ISOTemperatureLine_Specification_Robertson1968:
 
 def mired_to_CCT(mired: ArrayLike) -> NDArrayFloat:
     """
-    Convert given micro reciprocal degree to correlated colour temperature
+    Convert specified micro reciprocal degree to correlated colour temperature
     :math:`T_{cp}`.
 
     Parameters
@@ -181,7 +181,7 @@ def mired_to_CCT(mired: ArrayLike) -> NDArrayFloat:
 
 def CCT_to_mired(CCT: ArrayLike) -> NDArrayFloat:
     """
-    Convert given correlated colour temperature :math:`T_{cp}` to micro
+    Convert specified correlated colour temperature :math:`T_{cp}` to micro
     reciprocal degree (mired).
 
     Parameters
@@ -208,8 +208,8 @@ def CCT_to_mired(CCT: ArrayLike) -> NDArrayFloat:
 
 def _uv_to_CCT_Robertson1968(uv: ArrayLike) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` and
-    :math:`\\Delta_{uv}` from given *CIE UCS* colourspace *uv* chromaticity
+    Compute the correlated colour temperature :math:`T_{cp}` and
+    :math:`\\Delta_{uv}` from specified *CIE UCS* colourspace *uv* chromaticity
     coordinates using *Roberston (1968)* method.
 
     Parameters
@@ -276,8 +276,8 @@ def _uv_to_CCT_Robertson1968(uv: ArrayLike) -> NDArrayFloat:
 
 def uv_to_CCT_Robertson1968(uv: ArrayLike) -> NDArrayFloat:
     """
-    Return the correlated colour temperature :math:`T_{cp}` and
-    :math:`\\Delta_{uv}` from given *CIE UCS* colourspace *uv* chromaticity
+    Compute the correlated colour temperature :math:`T_{cp}` and
+    :math:`\\Delta_{uv}` from specified *CIE UCS* colourspace *uv* chromaticity
     coordinates using *Roberston (1968)* method.
 
     Parameters
@@ -310,7 +310,7 @@ def uv_to_CCT_Robertson1968(uv: ArrayLike) -> NDArrayFloat:
 
 def _CCT_to_uv_Robertson1968(CCT_D_uv: ArrayLike) -> NDArrayFloat:
     """
-    Return the *CIE UCS* colourspace *uv* chromaticity coordinates from given
+    Compute the *CIE UCS* colourspace *uv* chromaticity coordinates from specified
     correlated colour temperature :math:`T_{cp}` and :math:`\\Delta_{uv}` using
     *Roberston (1968)* method.
 
@@ -370,7 +370,7 @@ def _CCT_to_uv_Robertson1968(CCT_D_uv: ArrayLike) -> NDArrayFloat:
 
 def CCT_to_uv_Robertson1968(CCT_D_uv: ArrayLike) -> NDArrayFloat:
     """
-    Return the *CIE UCS* colourspace *uv* chromaticity coordinates from given
+    Compute the *CIE UCS* colourspace *uv* chromaticity coordinates from specified
     correlated colour temperature :math:`T_{cp}` and :math:`\\Delta_{uv}` using
     *Roberston (1968)* method.