@@ -81,7 +81,7 @@ magic numbers you will also need to set the ``binary`` attr to True.
8181
8282
8383 Formats will contain metadata in a separate header file can be defined using
84- the `` WithSeparateHeader ` ` mixin.
84+ the :class: ` . WithSeparateHeader ` mixin.
8585
8686.. code-block :: python
8787
@@ -113,10 +113,10 @@ return a dictionary containing metadata for the file-set.
113113 ' 0001'
114114
115115
116- Similar to `` WithSeparateHeader ``, `` WithSideCars ` ` can be used to define a format that
116+ Similar to :class: ` . WithSeparateHeader `, :class: ` . WithSideCars ` can be used to define a format that
117117contains some metadata within the main file, and additional metadata in a separate
118- "side-car" file. It can be used the same as `` WithSeparateHeader ` `, however, the
119- type of the primary file that reads the metadata from the binary file with ``read_metadata ``
118+ "side-car" file. It can be used the same as :class: ` . WithSeparateHeader `, however, the
119+ type of the primary file that reads the metadata from the binary file with ``read_metadata() ``
120120must also be defined in ``primary_type ``
121121
122122
@@ -137,7 +137,7 @@ for your format. This is simply done by adding a new property to the class using
137137
138138Take for example the `GIS shapefile structure <https://www.earthdatascience.org/courses/earth-analytics/spatial-data-r/shapefile-structure/ >`_,
139139it is a file-set consisting of 3 to 6 files differentiated by their extensions. To
140- implement this class we use the ``@property `` decorator. We inherit from the `` WithAdjacentFiles ` `
140+ implement this class we use the ``@property `` decorator. We inherit from the :class: ` . WithAdjacentFiles `
141141mixin so that neighbouring files (i.e. files with the same stem but different extension)
142142are included when the class is instantiated with just the primary ".shp" file.
143143
@@ -219,7 +219,7 @@ Properties that appear in ``fspaths`` attribute of the object are considered to
219219even when the ``trim `` argument is set to True.
220220
221221After the required properties have been deeper checks can be by using the ``check ``
222- decorator. Take the `` fileformats.image.Tiff ` ` class
222+ decorator. Take the :class: ` fileformats.image.Tiff ` class
223223
224224.. code-block :: python
225225
@@ -248,10 +248,9 @@ decorator. Take the ``fileformats.image.Tiff`` class
248248 )
249249 return endianness
250250
251- The `` Tiff ` ` format class needs to check two different magic numbers, one for big endian
251+ The :class: ` . Tiff ` format class needs to check two different magic numbers, one for big endian
252252files and another one for little endian files. Therefore we can't just use the
253- ``WithMagicNumber `` mixin and have to roll our own, ``endianness `` is decorated with
254- ``fileformats.core.mark.check ``.
253+ :class: `.WithMagicNumber ` mixin and have to roll our own.
255254
256255
257256Extra methods
0 commit comments