Update various docstrings.

colour-science · May 29, 2021 · ee18e9a · ee18e9a
1 parent f8032b3
commit ee18e9a
Show file tree

Hide file tree

Showing 20 changed files with 25 additions and 20 deletions.
diff --git a/colour_datasets/loaders/tests/test_abstract.py b/colour_datasets/loaders/tests/test_abstract.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.abstract` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.abstract` module.
 """
 
 import unittest

diff --git a/colour_datasets/loaders/tests/test_asano2015.py b/colour_datasets/loaders/tests/test_asano2015.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.asano2015` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.asano2015` module.
 """
 
 import numpy as np

diff --git a/colour_datasets/loaders/tests/test_brendel2020.py b/colour_datasets/loaders/tests/test_brendel2020.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.brendel2020` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.brendel2020`
+module.
 """
 
 import unittest

diff --git a/colour_datasets/loaders/tests/test_dyer2017.py b/colour_datasets/loaders/tests/test_dyer2017.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.dyer2017` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.dyer2017` module.
 """
 
 import numpy as np

diff --git a/colour_datasets/loaders/tests/test_ebner1998.py b/colour_datasets/loaders/tests/test_ebner1998.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.ebner1998` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.ebner1998` module.
 """
 
 import numpy as np

diff --git a/colour_datasets/loaders/tests/test_hung1995.py b/colour_datasets/loaders/tests/test_hung1995.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.hung1995` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.hung1995` module.
 """
 
 import numpy as np

diff --git a/colour_datasets/loaders/tests/test_jakob2019.py b/colour_datasets/loaders/tests/test_jakob2019.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.jakob2019` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.jakob2019` module.
 """
 
 import unittest

diff --git a/colour_datasets/loaders/tests/test_jiang2013.py b/colour_datasets/loaders/tests/test_jiang2013.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.jiang2013` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.jiang2013` module.
 """
 
 import unittest

diff --git a/colour_datasets/loaders/tests/test_karge2015.py b/colour_datasets/loaders/tests/test_karge2015.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.karge2015` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.karge2015` module.
 """
 
 import unittest

diff --git a/colour_datasets/loaders/tests/test_kuopio.py b/colour_datasets/loaders/tests/test_kuopio.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.kuopio` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.kuopio` module.
 """
 
 import numpy as np

diff --git a/colour_datasets/loaders/tests/test_labsphere2019.py b/colour_datasets/loaders/tests/test_labsphere2019.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.labsphere2019` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.labsphere2019`
+module.
 """
 
 import unittest

diff --git a/colour_datasets/loaders/tests/test_luo1997.py b/colour_datasets/loaders/tests/test_luo1997.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.luo1997` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.luo1997` module.
 """
 
 import numpy as np

diff --git a/colour_datasets/loaders/tests/test_luo1999.py b/colour_datasets/loaders/tests/test_luo1999.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.luo1999` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.luo1999` module.
 """
 
 import numpy as np

diff --git a/colour_datasets/loaders/tests/test_xrite2016.py b/colour_datasets/loaders/tests/test_xrite2016.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.xrite2016` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.xrite2016` module.
 """
 
 import unittest

diff --git a/colour_datasets/loaders/tests/test_zhao2009.py b/colour_datasets/loaders/tests/test_zhao2009.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.loaders.zhao2009` module.
+Defines the unit tests for the :mod:`colour_datasets.loaders.zhao2009` module.
 """
 
 import unittest

diff --git a/colour_datasets/records/tests/test_configuration.py b/colour_datasets/records/tests/test_configuration.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.records.configuration` module.
+Defines the unit tests for the :mod:`colour_datasets.records.configuration`
+module.
 """
 
 import unittest

diff --git a/colour_datasets/records/tests/test_zenodo.py b/colour_datasets/records/tests/test_zenodo.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.records.configuration` module.
+Defines the unit tests for the :mod:`colour_datasets.records.configuration`
+module.
 """
 
 import os

diff --git a/colour_datasets/utilities/common.py b/colour_datasets/utilities/common.py
@@ -3,7 +3,7 @@
 Common Utilities
 ================
 
-Defines common utilities objects that don't fall in any specific category.
+Defines the common utilities objects that don't fall in any specific category.
 """
 
 import functools

diff --git a/colour_datasets/utilities/tests/test_common.py b/colour_datasets/utilities/tests/test_common.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.utilities.common` module.
+Defines the unit tests for the :mod:`colour_datasets.utilities.common` module.
 """
 
 import os

diff --git a/colour_datasets/utilities/tests/test_spreadsheet.py b/colour_datasets/utilities/tests/test_spreadsheet.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """
-Defines unit tests for :mod:`colour_datasets.utilities.spreadsheet` module.
+Defines the unit tests for the :mod:`colour_datasets.utilities.spreadsheet`
+module.
 """
 
 import os