Merge pull request #182 from sadielbartholomew/examples-docstring-for…

…matting Batch docstring formatting update: 'Examples:' -> 'Examples'
NCAS-CMS · Mar 22, 2022 · a0bf44c · a0bf44c
2 parents 1e1c74a + d1a5326
commit a0bf44c
Show file tree

Hide file tree

Showing 47 changed files with 380 additions and 380 deletions.
diff --git a/cfdm/abstract/implementation.py b/cfdm/abstract/implementation.py
@@ -27,7 +27,7 @@ def classes(self):
             `dict`
                 The class objects, keyed by their class name.
 
-        **Examples:**
+        **Examples**
 
         >>> i = cfdm.Implementation()  # an abstract implementation
         >>> i.classes()
@@ -83,7 +83,7 @@ def get_class(self, name):
 
                 The class object.
 
-        **Examples:**
+        **Examples**
 
         >>> i = cfdm.implementation()  # child CF data model implementation
         >>> Field = i.get_class('Field')
@@ -103,7 +103,7 @@ def get_cf_version(self):
             `str`
                 The version.
 
-        **Examples:**
+        **Examples**
 
         >>> i = cfdm.implementation()  # child CF data model implementation
         >>> i.get_cf_version()
@@ -130,7 +130,7 @@ def set_class(self, name, cls):
 
             `None`
 
-        **Examples:**
+        **Examples**
 
         >>> i = cfdm.Implementation()  # child CF data model implementation
         >>> i.classes()

diff --git a/cfdm/bounds.py b/cfdm/bounds.py
@@ -162,7 +162,7 @@ def get_data(self, default=ValueError(), _units=True, _fill_value=True):
             `Data`
                 The data.
 
-        **Examples:**
+        **Examples**
 
         >>> f = {{package}}.Field(
         ...     properties={'standard_name': 'surface_altitude'})
@@ -229,7 +229,7 @@ def inherited_properties(self):
             `dict`
                 The inherited properties.
 
-        **Examples:**
+        **Examples**
 
         >>> f = {{package}}.example_field(6)
         >>> d = f.constructs('longitude').value()
@@ -270,7 +270,7 @@ def identity(self, default=""):
 
                 The identity.
 
-        **Examples:**
+        **Examples**
 
         >>> f = {{package}}.example_field(6)
         >>> d = f.constructs('longitude').value()

diff --git a/cfdm/cellmeasure.py b/cfdm/cellmeasure.py
@@ -130,7 +130,7 @@ def creation_commands(
 
             {{returns creation_commands}}
 
-        **Examples:**
+        **Examples**
 
         >>> x = {{package}}.CellMeasure(
         ...     measure='area',
@@ -285,7 +285,7 @@ def equals(
             `bool`
                 Whether the two cell measure constructs are equal.
 
-        **Examples:**
+        **Examples**
 
         >>> c = {{package}}.CellMeasure()
         >>> c.set_properties({'units': 'm2'})
@@ -355,7 +355,7 @@ def identity(self, default=""):
 
                 The identity.
 
-        **Examples:**
+        **Examples**
 
         >>> f = {{package}}.example_field(1)
         >>> c = f.get_construct('cellmeasure0')
@@ -434,7 +434,7 @@ def identities(self, generator=False, **kwargs):
             `list` or generator
                 The identities.
 
-        **Examples:**
+        **Examples**
 
         >>> f = {{package}}.example_field(1)
         >>> c = f.get_construct('cellmeasure0')

diff --git a/cfdm/cellmethod.py b/cfdm/cellmethod.py
@@ -126,7 +126,7 @@ def creation_commands(
 
             {{returns creation_commands}}
 
-        **Examples:**
+        **Examples**
 
         >>> x = {{package}}.CellMethod(
         ...     axes=['area'],
@@ -271,7 +271,7 @@ def equals(
             `bool`
                 Whether the two cell method constructs are equal.
 
-        **Examples:**
+        **Examples**
 
         >>> c = {{package}}.CellMethod()
         >>> c.equals(c)
@@ -408,7 +408,7 @@ def identity(self, default=""):
 
                 The identity.
 
-        **Examples:**
+        **Examples**
 
         >>> f = {{package}}.example_field(1)
         >>> c = f.get_construct('cellmethod1')
@@ -460,7 +460,7 @@ def identities(self, generator=False, **kwargs):
             `list` or generator
                 The identities.
 
-        **Examples:**
+        **Examples**
 
         >>> f = {{package}}.example_field(1)
         >>> c = f.get_construct('cellmethod1')
@@ -503,7 +503,7 @@ def sorted(self, indices=None):
             `CellMethod`
                 A new cell method construct with sorted axes.
 
-        **Examples:**
+        **Examples**
 
         >>> cm = {{package}}.CellMethod(axes=['domainaxis1', 'domainaxis0'],
         ...                      method='mean',

diff --git a/cfdm/cfdmimplementation.py b/cfdm/cfdmimplementation.py
@@ -887,7 +887,7 @@ def get_data_ndim(self, parent):
             `int`
                 The number of dimensions spanned by the data array.
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
         >>> d = cfdm.DimensionCoordinate(
@@ -929,7 +929,7 @@ def get_data_shape(self, parent, isdata=False):
             `tuple`
                 The shape of the data array.
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
         >>> d = cfdm.DimensionCoordinate(
@@ -971,7 +971,7 @@ def get_data_size(self, parent):
             `int`
                 The number of elements in the data array.
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
         >>> d = cfdm.DimensionCoordinate(
@@ -1413,7 +1413,7 @@ def get_field_ancillaries(self, field):
                 A dictionary whose values are field ancillary objects, keyed
                 by unique identifiers.
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
         >>> f = cfdm.example_field(1)
@@ -1610,7 +1610,7 @@ def get_measure(self, cell_measure):
             `str` or `None`
                 The measure property, or `None` if it has not been set.
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
         >>> c = cfdm.CellMeasure(
@@ -1705,7 +1705,7 @@ def get_properties(self, parent):
             `dict`
                 The property names and their values
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
         >>> d = cfdm.DimensionCoordinate(
@@ -1771,7 +1771,7 @@ def get_data(self, parent, default=None):
 
                 The data.
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
         >>> d = cfdm.DimensionCoordinate(
@@ -3277,7 +3277,7 @@ def has_datum(self, coordinate_reference):
 
             `bool`
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
 
@@ -3327,7 +3327,7 @@ def has_property(self, parent, prop):
             `bool`
                 `True` if the property exists, otherwise `False`.
 
-        **Examples:**
+        **Examples**
 
         >>> w = cfdm.implementation()
         >>> d = cfdm.DimensionCoordinate(
@@ -3415,7 +3415,7 @@ def implementation():
         `CFDMImplementation`
             A container for the CF data model implementation.
 
-    **Examples:**
+    **Examples**
 
     >>> i = cfdm.implementation()
     >>> i