Skip to content

Commit 1015a4a

Browse files
committed
docs
1 parent eb7b8b3 commit 1015a4a

File tree

12 files changed

+78
-11
lines changed

12 files changed

+78
-11
lines changed

cf/field.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11978,13 +11978,13 @@ def pad_missing(self, axis, pad_width=None, to_size=None, inplace=False):
1197811978

1197911979
{{inplace: `bool`, optional}}
1198011980

11981-
:Returns:
11981+
:Returns:
1198211982

11983-
`Field` or `None`
11984-
The padded field construct, or `None` if the operation
11985-
was in-place.
11983+
`Field` or `None`
11984+
The padded field construct, or `None` if the operation
11985+
was in-place.
1198611986

11987-
**Examples*
11987+
**Examples**
1198811988

1198911989
>>> f = cf.example_field(6)
1199011990
>>> print(f)

docs/source/class/cf.AuxiliaryCoordinate.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,7 @@ Data
262262
:template: method.rst
263263

264264
~cf.AuxiliaryCoordinate.halo
265+
~cf.AuxiliaryCoordinate.pad_missing
265266

266267
.. rubric:: *Data array mask*
267268

docs/source/class/cf.Bounds.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,16 @@ Data
170170
~cf.Bounds.swapaxes
171171
~cf.Bounds.transpose
172172

173+
.. rubric:: *Expanding the data*
174+
175+
.. autosummary::
176+
:nosignatures:
177+
:toctree: ../method/
178+
:template: method.rst
179+
180+
~cf.Bounds.halo
181+
~cf.Bounds.pad_missing
182+
173183
.. rubric:: *Data array mask*
174184

175185
.. autosummary::
@@ -205,7 +215,6 @@ Data
205215
:template: method.rst
206216

207217
~cf.Bounds.__setitem__
208-
~cf.Bounds.halo
209218
~cf.Bounds.masked_invalid
210219
~cf.Bounds.subspace
211220
~cf.Bounds.where

docs/source/class/cf.CellMeasure.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,16 @@ Data
193193
~cf.CellMeasure.swapaxes
194194
~cf.CellMeasure.transpose
195195

196+
.. rubric:: *Expanding the data*
197+
198+
.. autosummary::
199+
:nosignatures:
200+
:toctree: ../method/
201+
:template: method.rst
202+
203+
~cf.CellMeasure.halo
204+
~cf.CellMeasure.pad_missing
205+
196206
.. rubric:: *Data array mask*
197207

198208
.. autosummary::
@@ -228,7 +238,6 @@ Data
228238
:template: method.rst
229239

230240
~cf.CellMeasure.__setitem__
231-
~cf.CellMeasure.halo
232241
~cf.CellMeasure.masked_invalid
233242
~cf.CellMeasure.subspace
234243
~cf.CellMeasure.where

docs/source/class/cf.Count.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,15 @@ Data
165165
~cf.Count.swapaxes
166166
~cf.Count.transpose
167167

168+
.. rubric:: *Expanding the data*
169+
170+
.. autosummary::
171+
:nosignatures:
172+
:toctree: ../method/
173+
:template: method.rst
174+
175+
~cf.Count.pad_missing
176+
168177
.. rubric:: *Data array mask*
169178

170179
.. autosummary::

docs/source/class/cf.Data.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ Expanding the data
195195
:template: method.rst
196196

197197
~cf.Data.halo
198+
~cf.Data.pad_missing
198199

199200
Binary operations
200201
^^^^^^^^^^^^^^^^^

docs/source/class/cf.DimensionCoordinate.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,7 @@ Data
268268
:template: method.rst
269269

270270
~cf.DimensionCoordinate.halo
271+
~cf.DimensionCoordinate.pad_missing
271272

272273
.. rubric:: *Data array mask*
273274

docs/source/class/cf.DomainAncillary.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,16 @@ Data
239239
~cf.DomainAncillary.swapaxes
240240
~cf.DomainAncillary.transpose
241241

242+
.. rubric:: *Expanding the data*
243+
244+
.. autosummary::
245+
:nosignatures:
246+
:toctree: ../method/
247+
:template: method.rst
248+
249+
~cf.DomainAncillary.halo
250+
~cf.DomainAncillary.pad_missing
251+
242252
.. rubric:: *Data array mask*
243253

244254
.. autosummary::
@@ -274,7 +284,6 @@ Data
274284
:template: method.rst
275285

276286
~cf.DomainAncillary.__setitem__
277-
~cf.DomainAncillary.halo
278287
~cf.DomainAncillary.masked_invalid
279288
~cf.DomainAncillary.subspace
280289
~cf.DomainAncillary.where

docs/source/class/cf.Field.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ Data
196196
:template: method.rst
197197

198198
~cf.Field.halo
199+
~cf.Field.pad_missing
199200

200201
.. rubric:: *Data array mask*
201202

docs/source/class/cf.FieldAncillary.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,16 @@ Data
169169
~cf.FieldAncillary.swapaxes
170170
~cf.FieldAncillary.transpose
171171

172+
.. rubric:: *Expanding the data*
173+
174+
.. autosummary::
175+
:nosignatures:
176+
:toctree: ../method/
177+
:template: method.rst
178+
179+
~cf.FieldAncillary.halo
180+
~cf.FieldAncillary.pad_missing
181+
172182
.. rubric:: *Data array mask*
173183

174184
.. autosummary::
@@ -204,7 +214,6 @@ Data
204214
:template: method.rst
205215

206216
~cf.FieldAncillary.__setitem__
207-
~cf.FieldAncillary.halo
208217
~cf.FieldAncillary.masked_invalid
209218
~cf.FieldAncillary.subspace
210219
~cf.FieldAncillary.where

0 commit comments

Comments
 (0)