refactor: change signature_path option to signature_name

Author: machow

quartodoc/builder/blueprint.py

@@ -327,7 +327,11 @@ def enter(self, el: Auto):
 
         is_flat = el.children == ChoicesChildren.flat
         return Doc.from_griffe(
-            el.name, obj, children, flat=is_flat, signature_path=el.signature_path
+            el.name,
+            obj,
+            children,
+            flat=is_flat,
+            signature_name=el.signature_name,
         )
 
     @staticmethod

quartodoc/layout.py

@@ -207,7 +207,7 @@ class ChoicesChildren(Enum):
 class AutoOptions(_Base):
     """Options available for Auto content layout element."""
 
-    signature_path: SignatureOptions = "relative"
+    signature_name: SignatureOptions = "relative"
     members: Optional[list[str]] = None
     include_private: bool = False
     include_imports: bool = False
@@ -335,7 +335,7 @@ class Doc(_Docable):
     name: str
     obj: Union[dc.Object, dc.Alias]
     anchor: str
-    signature_path: SignatureOptions = "relative"
+    signature_name: SignatureOptions = "relative"
 
     class Config:
         arbitrary_types_allowed = True
@@ -349,7 +349,7 @@ def from_griffe(
         members=None,
         anchor: str = None,
         flat: bool = False,
-        signature_path: str = "relative",
+        signature_name: str = "relative",
     ):
         if members is None:
             members = []
@@ -361,7 +361,7 @@ def from_griffe(
             "name": name,
             "obj": obj,
             "anchor": anchor,
-            "signature_path": signature_path,
+            "signature_name": signature_name,
         }
 
         if kind == "function":

quartodoc/renderers/md_renderer.py

@@ -137,7 +137,7 @@ def signature(self, el: layout.Doc):
         # TODO: this is for backwards compatibility with the old approach
         # of only defining signature over griffe objects, which projects
         # like shiny currently extend
-        self.display_name = el.signature_path
+        self.display_name = el.signature_name
         res = self.signature(el.obj)
         self.display_name = orig
 

quartodoc/tests/__snapshots__/test_renderers.ambr

@@ -232,7 +232,7 @@
   A function
   '''
 # ---
-# name: test_render_doc_signature_path
+# name: test_render_doc_signature_name
   '''
   # example.a_func { #quartodoc.tests.example.a_func }
 

quartodoc/tests/test_builder_blueprint.py

@@ -188,14 +188,14 @@ def test_blueprint_fetch_members_include_inherited():
 def test_blueprint_member_options():
     auto = lo.Auto(
         name="quartodoc.tests.example",
-        member_options={"signature_path": "short"},
+        member_options={"signature_name": "short"},
         members=["AClass"],
     )
     bp = blueprint(auto)
     doc_a_class = bp.members[0]
 
     # member has option set
-    assert doc_a_class.signature_path == "short"
+    assert doc_a_class.signature_name == "short"
 
     # this currently does not apply to members of members
-    assert doc_a_class.members[0].signature_path == "relative"
+    assert doc_a_class.members[0].signature_name == "relative"

quartodoc/tests/test_renderers.py

@@ -147,9 +147,9 @@ def test_render_docstring_numpy_linebreaks(snapshot, renderer):
     assert res == snapshot
 
 
-def test_render_doc_signature_path(snapshot, renderer):
+def test_render_doc_signature_name(snapshot, renderer):
     package = "quartodoc.tests"
-    auto = Auto(name="example.a_func", package=package, signature_path="short")
+    auto = Auto(name="example.a_func", package=package, signature_name="short")
     bp = blueprint(auto)
 
     res = renderer.render(bp)