Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Batch docstring formatting update: 'Examples:' -> 'Examples' #182

Merged
merged 1 commit into from
Mar 22, 2022
Merged

Batch docstring formatting update: 'Examples:' -> 'Examples' #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions cfdm/abstract/implementation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down Expand Up @@ -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')
Expand All @@ -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()
Expand All @@ -130,7 +130,7 @@ def set_class(self, name, cls):

`None`

**Examples:**
**Examples**

>>> i = cfdm.Implementation() # child CF data model implementation
>>> i.classes()
Expand Down
6 changes: 3 additions & 3 deletions cfdm/bounds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'})
Expand Down Expand Up @@ -229,7 +229,7 @@ def inherited_properties(self):
`dict`
The inherited properties.

**Examples:**
**Examples**

>>> f = {{package}}.example_field(6)
>>> d = f.constructs('longitude').value()
Expand Down Expand Up @@ -270,7 +270,7 @@ def identity(self, default=""):

The identity.

**Examples:**
**Examples**

>>> f = {{package}}.example_field(6)
>>> d = f.constructs('longitude').value()
Expand Down
8 changes: 4 additions & 4 deletions cfdm/cellmeasure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def creation_commands(

{{returns creation_commands}}

**Examples:**
**Examples**

>>> x = {{package}}.CellMeasure(
... measure='area',
Expand Down Expand Up @@ -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'})
Expand Down Expand Up @@ -355,7 +355,7 @@ def identity(self, default=""):

The identity.

**Examples:**
**Examples**

>>> f = {{package}}.example_field(1)
>>> c = f.get_construct('cellmeasure0')
Expand Down Expand Up @@ -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')
Expand Down
10 changes: 5 additions & 5 deletions cfdm/cellmethod.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ def creation_commands(

{{returns creation_commands}}

**Examples:**
**Examples**

>>> x = {{package}}.CellMethod(
... axes=['area'],
Expand Down Expand Up @@ -271,7 +271,7 @@ def equals(
`bool`
Whether the two cell method constructs are equal.

**Examples:**
**Examples**

>>> c = {{package}}.CellMethod()
>>> c.equals(c)
Expand Down Expand Up @@ -408,7 +408,7 @@ def identity(self, default=""):

The identity.

**Examples:**
**Examples**

>>> f = {{package}}.example_field(1)
>>> c = f.get_construct('cellmethod1')
Expand Down Expand Up @@ -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')
Expand Down Expand Up @@ -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',
Expand Down
20 changes: 10 additions & 10 deletions cfdm/cfdmimplementation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -1705,7 +1705,7 @@ def get_properties(self, parent):
`dict`
The property names and their values

**Examples:**
**Examples**

>>> w = cfdm.implementation()
>>> d = cfdm.DimensionCoordinate(
Expand Down Expand Up @@ -1771,7 +1771,7 @@ def get_data(self, parent, default=None):

The data.

**Examples:**
**Examples**

>>> w = cfdm.implementation()
>>> d = cfdm.DimensionCoordinate(
Expand Down Expand Up @@ -3277,7 +3277,7 @@ def has_datum(self, coordinate_reference):

`bool`

**Examples:**
**Examples**

>>> w = cfdm.implementation()

Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -3415,7 +3415,7 @@ def implementation():
`CFDMImplementation`
A container for the CF data model implementation.

**Examples:**
**Examples**

>>> i = cfdm.implementation()
>>> i
Expand Down
Loading