docstring

NCAS-CMS · Nov 11, 2024 · 5e57272 · 5e57272
1 parent 0180408
commit 5e57272
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/cf/dimensioncoordinate.py b/cf/dimensioncoordinate.py
@@ -327,14 +327,18 @@ def anchor(self, value, cell=False, parameters=None, inplace=False):
                 (decreasing) coordinates.
 
             parameters: `dict`, optional
-                TODO Return a dictionary of parameters which describe the
-                anchoring process. The construct is not changed, even
-                if *inplace* is True.
+                If a `dict` is provided then it will be updated
+                in-place with parameters which describe thethe
+                anchoring process.
 
             {{inplace: `bool`, optional}}
 
         :Returns:
 
+            `{{class}}` or `None`
+                The anchored dimension coordinates, or `None` if the
+                operation was in-place.
+
         """
         d = _inplace_enabled_define_and_cleanup(self)