schema: use typedef description for type

samuel-gauthier · rjarry · commit ef885cc94977 · 2023-07-12T13:20:48.000+02:00
When available, use the typedef's description for type.

Signed-off-by: Samuel Gauthier &lt;samuel.gauthier@6wind.com&gt;
Acked-by: Robin Jarry &lt;robin@jarry.cc&gt;
diff --git a/libyang/schema.py b/libyang/schema.py
@@ -516,6 +516,9 @@ def name(self) -> str:
         return self.basename()
 
     def description(self) -> Optional[str]:
+        typedef = self.typedef()
+        if typedef:
+            return typedef.description()
         return None
 
     def base(self) -> int:
diff --git a/tests/test_schema.py b/tests/test_schema.py
@@ -382,6 +382,7 @@ def test_leaf_type_derived(self):
         self.assertEqual(mod.get_module_from_prefix("types").name(), "wtf-types")
         self.assertEqual(t.typedef().name(), "host")
         self.assertEqual(t.typedef().description(), "my host type.")
+        self.assertEqual(t.description(), "my host type.")
 
     def test_leaf_type_status(self):
         leaf = next(self.ctx.find_path("/yolo-system:conf/yolo-system:hostname"))
