Add docstring for synonyms

freegs-plasma · Sep 23, 2024 · e1b4bea · e1b4bea
1 parent 7742478
commit e1b4bea
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/freeqdsk/geqdsk.py b/freeqdsk/geqdsk.py
@@ -189,6 +189,7 @@ def _synonym(canonical: str) -> property:
     return property(
         lambda self: getattr(self, canonical),
         lambda self, value: setattr(self, canonical, value),
+        doc=f"Synonym for {canonical}",
     )