Change style of documentation references.

clairmeta/dcp_check.py

@@ -106,7 +106,7 @@ def run_checks(self):
     def check_dcp_empty_dir(self):
         """ Empty directory detection.
 
-            Reference : N/A
+            References: N/A
         """
         list_empty_dir = []
         for dirpath, dirnames, filenames in os.walk(self.dcp.path):
@@ -123,7 +123,7 @@ def check_dcp_empty_dir(self):
     def check_dcp_hidden_files(self):
         """ Hidden files detection.
 
-            Reference : N/A
+            References: N/A
         """
         hidden_files = [
             os.path.relpath(f, self.dcp.path)
@@ -136,7 +136,7 @@ def check_dcp_hidden_files(self):
     def check_dcp_foreign_files(self):
         """ Foreign files detection (not listed in AssetMap).
 
-            Reference : N/A
+            References: N/A
         """
         list_asset_path = [
             os.path.join(self.dcp.path, a)
@@ -154,7 +154,7 @@ def check_dcp_foreign_files(self):
     def check_dcp_multiple_am_or_vol(self):
         """ Only one AssetMap and VolIndex shall be present.
 
-            Reference : N/A
+            References: N/A
         """
         restricted_lists = {
             'VolIndex': self.dcp._list_vol,
@@ -182,9 +182,9 @@ def setup_dcp_link_ov(self):
     def check_dcp_signed(self):
         """ DCP with encrypted content must be digitally signed.
 
-            Reference :
-                DCI Spec 1.3 5.4.3.7.
-                DCI Spec 1.3 5.5.2.3.
+            References:
+                DCI DCSS (v1.3) 5.4.3.7
+                DCI DCSS (v1.3) 5.5.2.3
         """
         for cpl in self.dcp._list_cpl:
             cpl_node = cpl['Info']['CompositionPlaylist']
@@ -201,7 +201,7 @@ def check_dcp_signed(self):
     def check_link_ov_coherence(self):
         """ Relink OV/VF sanity checks.
 
-            Reference : N/A
+            References: N/A
         """
         if self.ov_path and self.dcp.package_type != 'VF':
             raise CheckException("Package checked must be a VF")
@@ -215,7 +215,7 @@ def check_link_ov_coherence(self):
     def check_link_ov_asset(self, asset, essence):
         """ VF package shall reference assets present in OV.
 
-            Reference : N/A
+            References: N/A
         """
         if not self.ov_dcp:
             return

clairmeta/dcp_check_am.py

@@ -33,7 +33,7 @@ def run_checks(self):
     def check_am_xml(self, am):
         """ AssetMap XML syntax and structure check.
 
-            Reference : N/A
+            References: N/A
         """
         check_xml(
             am['FilePath'],
@@ -44,7 +44,7 @@ def check_am_xml(self, am):
     def check_am_name(self, am):
         """ AssetMap file name respect DCP standard.
 
-            Reference : N/A
+            References: N/A
         """
         schema = am['Info']['AssetMap']['Schema']
         mandatory_name = {
@@ -85,8 +85,8 @@ def check_am_empty_text_fields(self, am):
     def check_assets_am_uuid(self, am, asset):
         """ AssetMap UUIDs validation.
 
-            Reference :
-                SMPTE 429-9-2014 6.1
+            References:
+                SMPTE ST 429-9:2014 6.1
         """
         uuid, _, _ = asset
         if not check_uuid(uuid):
@@ -96,8 +96,8 @@ def check_assets_am_uuid(self, am, asset):
     def check_assets_am_volindex(self, am, asset):
         """ AssetMap assets shall reference existing VolIndex.
 
-            Reference :
-                Deprecated in SMPTE 429-9-2014
+            References:
+                SMPTE ST 429-9:2014
         """
         _, _, asset = asset
         # Note : schema already check for positive integer
@@ -109,8 +109,8 @@ def check_assets_am_volindex(self, am, asset):
     def check_assets_am_volindex_one(self, am, asset):
         """ AssetMap assets VolIndex shall be one or absent.
 
-            Reference :
-                SMPTE 429-9-2014 7.2
+            References:
+                SMPTE ST 429-9:2014 7.2
         """
         _, _, asset = asset
         asset_vol = asset['ChunkList']['Chunk'].get('VolumeIndex')
@@ -122,8 +122,8 @@ def check_assets_am_volindex_one(self, am, asset):
     def check_assets_am_path(self, am, asset):
         """ AssetMap assets path validation.
 
-            Reference :
-                SMPTE 429-9-2014 7.1
+            References:
+                SMPTE ST 429-9:2014 7.1
         """
         uuid, path, _ = asset
 
@@ -139,8 +139,8 @@ def check_assets_am_path(self, am, asset):
     def check_assets_am_size(self, am, asset):
         """ AssetMap assets size check.
 
-            Reference :
-                SMPTE 429-9-2014 7.4
+            References:
+                SMPTE ST 429-9:2014 7.4
         """
         _, path, asset = asset
         path = os.path.join(self.dcp.path, path)

clairmeta/dcp_check_atmos.py

@@ -28,8 +28,8 @@ def run_checks(self):
     def check_atmos_cpl_essence_encoding(self, playlist, asset):
         """ Atmos data essence coding universal label.
 
-            Reference :
-                SMPTE 429-18-2019 11
+            References:
+                SMPTE ST 429-18:2019 11
         """
         _, asset = asset
         ul = DCP_SETTINGS['atmos']['smpte_ul']
@@ -56,9 +56,10 @@ def check_atmos_cpl_channels(self, playlist, asset):
 
             This field will be optional (429-18).
 
-            Reference :
-                Dolby Atmos Next-Generation Audio for Cinema (WhitePaper)
-                SMPTE 429-18-2019 12 Table 4
+            References:
+                Dolby S14/26858/27819
+                https://web.archive.org/web/20190407130138/https://www.dolby.com/us/en/technologies/dolby-atmos/dolby-atmos-next-generation-audio-for-cinema-white-paper.pdf
+                SMPTE ST 429-18:2019 12 Table 4
         """
         _, asset = asset
         max_atmos = DCP_SETTINGS['atmos']['max_channel_count']
@@ -76,9 +77,10 @@ def check_atmos_cpl_objects(self, playlist, asset):
 
             This field will be optional (429-18).
 
-            Reference :
-                Dolby Atmos Next-Generation Audio for Cinema (WhitePaper)
-                SMPTE 429-18-2019 12 Table 4
+            References:
+                Dolby S14/26858/27819
+                https://web.archive.org/web/20190407130138/https://www.dolby.com/us/en/technologies/dolby-atmos/dolby-atmos-next-generation-audio-for-cinema-white-paper.pdf
+                SMPTE ST 429-18:2019 12 Table 4
         """
         _, asset = asset
         max_atmos = DCP_SETTINGS['atmos']['max_object_count']