Skip to content

Commit 5e57272

Browse files
committed
docstring
1 parent 0180408 commit 5e57272

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

cf/dimensioncoordinate.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -327,14 +327,18 @@ def anchor(self, value, cell=False, parameters=None, inplace=False):
327327
(decreasing) coordinates.
328328
329329
parameters: `dict`, optional
330-
TODO Return a dictionary of parameters which describe the
331-
anchoring process. The construct is not changed, even
332-
if *inplace* is True.
330+
If a `dict` is provided then it will be updated
331+
in-place with parameters which describe thethe
332+
anchoring process.
333333
334334
{{inplace: `bool`, optional}}
335335
336336
:Returns:
337337
338+
`{{class}}` or `None`
339+
The anchored dimension coordinates, or `None` if the
340+
operation was in-place.
341+
338342
"""
339343
d = _inplace_enabled_define_and_cleanup(self)
340344

0 commit comments

Comments
 (0)