Update docstrings in colour.volume package.

Author: KelSolaar

colour/volume/datasets/optimal_colour_stimuli.py

@@ -2,7 +2,7 @@
 Optimal Colour Stimuli
 ======================
 
-Define the *MacAdam Optimal Colour Stimuli* for various illuminants in
+*MacAdam Optimal Colour Stimuli* for various illuminants in
 *CIE xyY* colourspace.
 
 The *Optimal Colour Stimuli* data is in the form of a *dict* of

colour/volume/macadam_limits.py

@@ -2,7 +2,7 @@
 Optimal Colour Stimuli - MacAdam Limits
 =======================================
 
-Define the objects related to *Optimal Colour Stimuli* computations.
+Objects related to *Optimal Colour Stimuli* computations.
 """
 
 from __future__ import annotations
@@ -45,7 +45,7 @@ def _XYZ_optimal_colour_stimuli(
     illuminant: Literal["A", "C", "D65"] | str = "D65",
 ) -> NDArrayFloat:
     """
-    Return given illuminant *Optimal Colour Stimuli* in *CIE XYZ* tristimulus
+    Return specified illuminant *Optimal Colour Stimuli* in *CIE XYZ* tristimulus
     values and caches it if not existing.
 
     Parameters
@@ -85,8 +85,8 @@ def is_within_macadam_limits(
     tolerance: float = 100 * EPSILON,
 ) -> NDArrayFloat:
     """
-    Return whether given *CIE xyY* colourspace array is within MacAdam limits
-    of given illuminant.
+    Return whether specified *CIE xyY* colourspace array is within MacAdam limits
+    of specified illuminant.
 
     Parameters
     ----------
@@ -100,7 +100,7 @@ def is_within_macadam_limits(
     Returns
     -------
     :class:`numpy.ndarray`
-        Whether given *CIE xyY* colourspace array is within MacAdam limits.
+        Whether specified *CIE xyY* colourspace array is within MacAdam limits.
 
     Notes
     -----

colour/volume/mesh.py

@@ -2,7 +2,7 @@
 Mesh Volume Computation Helpers
 ===============================
 
-Define the helpers objects related to volume computations.
+Helper objects related to volume computations.
 """
 
 from __future__ import annotations
@@ -34,7 +34,7 @@ def is_within_mesh_volume(
     points: ArrayLike, mesh: ArrayLike, tolerance: float = 100 * EPSILON
 ) -> NDArrayFloat:
     """
-    Return whether given points are within given mesh volume using Delaunay
+    Return whether specified points are within specified mesh volume using Delaunay
     triangulation.
 
     Parameters
@@ -49,7 +49,7 @@ def is_within_mesh_volume(
     Returns
     -------
     :class:`numpy.ndarray`
-        Whether given points are within given mesh volume.
+        Whether specified points are within specified mesh volume.
 
     Examples
     --------

colour/volume/pointer_gamut.py

@@ -2,7 +2,7 @@
 Pointer's Gamut Volume Computations
 ===================================
 
-Define the objects related to *Pointer's Gamut* volume computations.
+Objects related to *Pointer's Gamut* volume computations.
 """
 
 from __future__ import annotations
@@ -38,7 +38,7 @@ def is_within_pointer_gamut(
     XYZ: ArrayLike, tolerance: float = 100 * EPSILON
 ) -> NDArrayFloat:
     """
-    Return whether given *CIE XYZ* tristimulus values are within Pointer's
+    Return whether specified *CIE XYZ* tristimulus values are within Pointer's
     Gamut volume.
 
     Parameters
@@ -51,7 +51,7 @@ def is_within_pointer_gamut(
     Returns
     -------
     :class:`numpy.ndarray`
-        Whether given *CIE XYZ* tristimulus values are within Pointer's Gamut
+        Whether specified *CIE XYZ* tristimulus values are within Pointer's Gamut
         volume.
 
     Notes

colour/volume/rgb.py

@@ -2,7 +2,7 @@
 RGB Colourspace Volume Computation
 ==================================
 
-Define various RGB colourspace volume computation objects:
+Various RGB colourspace volume computation objects:
 
 -   :func:`colour.RGB_colourspace_limits`
 -   :func:`colour.RGB_colourspace_volume_MonteCarlo`
@@ -91,7 +91,7 @@ def sample_RGB_colourspace_volume_MonteCarlo(
 ) -> int:
     """
     Randomly sample the *CIE L\\*a\\*b\\** colourspace volume and returns the
-    ratio of samples within the given *RGB* colourspace volume.
+    ratio of samples within the specified *RGB* colourspace volume.
 
     Parameters
     ----------
@@ -152,7 +152,7 @@ def sample_RGB_colourspace_volume_MonteCarlo(
 
 def RGB_colourspace_limits(colourspace: RGB_Colourspace) -> NDArrayFloat:
     """
-    Compute given *RGB* colourspace volume limits in *CIE L\\*a\\*b\\**
+    Compute specified *RGB* colourspace volume limits in *CIE L\\*a\\*b\\**
     colourspace.
 
     Parameters
@@ -167,7 +167,7 @@ def RGB_colourspace_limits(colourspace: RGB_Colourspace) -> NDArrayFloat:
 
     Notes
     -----
-    The limits are computed for the given *RGB* colourspace illuminant. This is
+    The limits are computed for the specified *RGB* colourspace illuminant. This is
     important to account for, if the intent is to compare various *RGB*
     colourspaces together. In this instance, they must be chromatically adapted
     to the same illuminant before-hand.
@@ -212,7 +212,7 @@ def RGB_colourspace_volume_MonteCarlo(
     random_state: np.random.RandomState | None = None,
 ) -> float:
     """
-    Perform given *RGB* colourspace volume computation using *Monte Carlo*
+    Perform specified *RGB* colourspace volume computation using *Monte Carlo*
     method and multiprocessing.
 
     Parameters
@@ -296,7 +296,7 @@ def RGB_colourspace_volume_coverage_MonteCarlo(
     random_state: np.random.RandomState | None = None,
 ) -> float:
     """
-    Return given *RGB* colourspace percentage coverage of an arbitrary volume.
+    Return specified *RGB* colourspace percentage coverage of an arbitrary volume.
 
     Parameters
     ----------
@@ -347,7 +347,7 @@ def RGB_colourspace_pointer_gamut_coverage_MonteCarlo(
     random_state: np.random.RandomState | None = None,
 ) -> float:
     """
-    Return given *RGB* colourspace percentage coverage of Pointer's Gamut
+    Return specified *RGB* colourspace percentage coverage of Pointer's Gamut
     volume using *Monte Carlo* method.
 
     Parameters
@@ -393,7 +393,7 @@ def RGB_colourspace_visible_spectrum_coverage_MonteCarlo(
     random_state: np.random.RandomState | None = None,
 ) -> float:
     """
-    Return given *RGB* colourspace percentage coverage of visible spectrum
+    Return specified *RGB* colourspace percentage coverage of visible spectrum
     volume using *Monte Carlo* method.
 
     Parameters

colour/volume/spectrum.py

@@ -2,7 +2,7 @@
 Rösch-MacAdam colour solid - Visible Spectrum Volume Computations
 =================================================================
 
-Define the objects related to *Rösch-MacAdam* colour solid, visible spectrum
+Objects related to *Rösch-MacAdam* colour solid, visible spectrum
 volume computations.
 
 References
@@ -82,7 +82,7 @@ def generate_pulse_waves(
     filter_jagged_pulses: bool = False,
 ) -> NDArrayFloat:
     """
-    Generate the pulse waves of given number of bins necessary to totally
+    Generate the pulse waves of specified number of bins necessary to totally
     stimulate the colour matching functions and produce the *Rösch-MacAdam*
     colour solid.
 
@@ -252,7 +252,7 @@ def XYZ_outer_surface(
 ) -> NDArrayFloat:
     """
     Generate the *Rösch-MacAdam* colour solid, i.e., *CIE XYZ* colourspace
-    outer surface, for given colour matching functions using multi-spectral
+    outer surface, for specified colour matching functions using multi-spectral
     conversion of pulse waves to *CIE XYZ* tristimulus values.
 
     Parameters
@@ -391,8 +391,8 @@ def is_within_visible_spectrum(
     **kwargs: Any,
 ) -> NDArrayFloat:
     """
-    Return whether given *CIE XYZ* tristimulus values are within the visible
-    spectrum volume, i.e., *Rösch-MacAdam* colour solid, for given colour
+    Return whether specified *CIE XYZ* tristimulus values are within the visible
+    spectrum volume, i.e., *Rösch-MacAdam* colour solid, for specified colour
     matching functions and illuminant.
 
     Parameters