Merge branch 'feature/v0.2.8' into develop

Author: KelSolaar

.coveragerc

@@ -3,7 +3,8 @@ source = colour_datasets
 sigterm = True
 [report]
 exclude_lines =
-    pragma: no cover
-    if __name__ == .__main__.:
     if TYPE_CHECKING:
+    if __name__ == .__main__.:
+    if typing.TYPE_CHECKING:
     pass
+    pragma: no cover

colour_datasets/loaders/dyer2017.py

@@ -160,7 +160,7 @@ def schema_version(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Schema version.
         """
 
@@ -190,7 +190,7 @@ def catalog_number(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Catalog number.
         """
 
@@ -220,7 +220,7 @@ def description(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Description.
         """
 
@@ -250,7 +250,7 @@ def document_creator(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Document creator.
         """
 
@@ -280,7 +280,7 @@ def unique_identifier(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Unique identifier.
         """
 
@@ -310,7 +310,7 @@ def measurement_equipment(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Measurement equipment.
         """
 
@@ -340,7 +340,7 @@ def laboratory(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Laboratory.
         """
 
@@ -370,7 +370,7 @@ def document_creation_date(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Document creation date.
         """
 
@@ -400,7 +400,7 @@ def comments(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Comments.
         """
 
@@ -430,7 +430,7 @@ def license(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Comments.
         """
 
@@ -625,7 +625,7 @@ def path(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Path.
         """
 
@@ -700,7 +700,7 @@ def units(
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Spectral units.
         """
 
@@ -765,7 +765,7 @@ def reflection_geometry(
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Reflection geometry.
         """
 
@@ -814,7 +814,7 @@ def transmission_geometry(
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Transmission geometry.
         """
 
@@ -847,7 +847,7 @@ def bandwidth_FWHM(self) -> float | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`numpy.floating`
+        :class:`float` or :py:data:`None`
             Full-width half-maximum bandwidth.
         """
 
@@ -878,7 +878,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.
         """
 
@@ -1129,7 +1129,7 @@ def path(self) -> str | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Path.
         """
 
@@ -1204,7 +1204,7 @@ def units(
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Spectral units.
         """
 
@@ -1269,7 +1269,7 @@ def reflection_geometry(
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Reflection geometry.
         """
 
@@ -1318,7 +1318,7 @@ def transmission_geometry(
 
         Returns
         -------
-        :py:data:`None` or :class:`str`
+        :class:`str` or :py:data:`None`
             Transmission geometry.
         """
 
@@ -1351,7 +1351,7 @@ def bandwidth_FWHM(self) -> float | None:
 
         Returns
         -------
-        :py:data:`None` or :class:`numpy.floating`
+        :class:`float` or :py:data:`None`
             Full-width half-maximum bandwidth.
         """
 
@@ -1382,7 +1382,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.
         """
 

tasks.py

@@ -241,8 +241,7 @@ def examples(ctx: Context) -> None:
 @task(formatting, quality, precommit, tests, examples)
 def preflight(ctx: Context) -> None:  # noqa: ARG001
     """
-    Perform the preflight tasks, i.e., *formatting*, *tests*, *quality*, and
-    *examples*.
+    Perform the preflight tasks.
 
     Parameters
     ----------
@@ -319,8 +318,7 @@ def requirements(ctx: Context) -> None:
 @task(clean, preflight, docs, todo, requirements)
 def build(ctx: Context) -> None:
     """
-    Build the project and runs dependency tasks, i.e., *docs*, *todo*, and
-    *preflight*.
+    Build the project and runs dependency tasks.
 
     Parameters
     ----------

utilities/unicode_to_ascii.py

@@ -68,4 +68,4 @@ def unicode_to_ascii(root_directory: str) -> None:
 if __name__ == "__main__":
     os.chdir(os.path.dirname(__file__))
 
-    unicode_to_ascii(os.path.join("..", "colour_checker_detection"))
+    unicode_to_ascii(os.path.join("..", "colour_datasets"))