From e1b4bea1edb03d303940ece5256ea0637842ea34 Mon Sep 17 00:00:00 2001
From: Peter Hill <peter.hill@york.ac.uk>
Date: Mon, 23 Sep 2024 09:49:56 +0100
Subject: [PATCH] Add docstring for synonyms

---
 freeqdsk/geqdsk.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/freeqdsk/geqdsk.py b/freeqdsk/geqdsk.py
index 129a312..4dbb089 100644
--- 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}",
     )