Skip to content

data batch docstring re-formatting: 'Examples:' -> 'Examples' #362

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

Merged
sadielbartholomew merged 1 commit into from
Mar 22, 2022
Merged

data batch docstring re-formatting: 'Examples:' -> 'Examples' #362

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
6 changes: 3 additions & 3 deletions cf/data/abstract/compressedsubarray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def file(self):
"""The file on disk which contains the compressed array, or
`None` of the array is in memory.

**Examples:**
**Examples**

>>> self.file
'/home/foo/bar.nc'
Expand All @@ -96,7 +96,7 @@ def close(self):

`None`

**Examples:**
**Examples**

>>> f.close()

Expand Down Expand Up @@ -127,7 +127,7 @@ def on_disk(self):
"""True if and only if the compressed array is on disk as
opposed to in memory.

**Examples:**
**Examples**

>>> a.on_disk()
True
Expand Down
14 changes: 7 additions & 7 deletions cf/data/abstract/filearray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def dask_asarray(self):
def dtype(self):
"""Data-type of the data elements.

**Examples:**
**Examples**

>>> a.dtype
dtype('float64')
Expand All @@ -50,7 +50,7 @@ def dtype(self):
def ndim(self):
"""Number of array dimensions.

**Examples:**
**Examples**

>>> a.shape
(73, 96)
Expand Down Expand Up @@ -80,7 +80,7 @@ def ndim(self):
def shape(self):
"""Tuple of array dimension sizes.

**Examples:**
**Examples**

>>> a.shape
(73, 96)
Expand Down Expand Up @@ -110,7 +110,7 @@ def shape(self):
def size(self):
"""Number of elements in the array.

**Examples:**
**Examples**

>>> a.shape
(73, 96)
Expand Down Expand Up @@ -140,7 +140,7 @@ def size(self):
def filename(self):
"""The name of the file containing the array.

**Examples:**
**Examples**

>>> a.filename()
'file.nc'
Expand All @@ -157,7 +157,7 @@ def array(self):
`numpy.ndarray`
An independent numpy array of the data.

**Examples:**
**Examples**

>>> n = numpy.asanyarray(a)
>>> isinstance(n, numpy.ndarray)
Expand All @@ -181,7 +181,7 @@ def inspect(self):
def get_filename(self):
"""Return the name of the file containing the array.

**Examples:**
**Examples**

>>> a.get_filename()
'file.nc'
Expand Down
2 changes: 1 addition & 1 deletion cf/data/cachedarray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def __init__(self, array):
array: numpy array
The array to be stored on disk in a temporary file.

**Examples:**
**Examples**

>>> f = CachedArray(numpy.array([1, 2, 3, 4, 5]))
>>> f = CachedArray(numpy.ma.array([1, 2, 3, 4, 5]))
Expand Down
2 changes: 1 addition & 1 deletion cf/data/collapse_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def psum(x, y):

`numpy.ndarray`

**Examples:**
**Examples**

>>> c = psum(a, b)

Expand Down
4 changes: 2 additions & 2 deletions cf/data/creation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def convert_to_builtin_type(x):

TODO

**Examples:**
**Examples**

>>> type(_convert_to_netCDF_datatype(numpy.bool_(True)))
bool
Expand Down Expand Up @@ -407,7 +407,7 @@ def generate_axis_identifiers(n):
`list`
The new axis idenfifiers.

**Examples:**
**Examples**

>>> generate_axis_identifiers(0)
[]
Expand Down
Loading