]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
docs(dnsdist): properly reference TimedIPSet as class
authorPieter Lexis <pieter.lexis@powerdns.com>
Thu, 22 Jan 2026 10:25:46 +0000 (11:25 +0100)
committerPieter Lexis <pieter.lexis@powerdns.com>
Mon, 23 Mar 2026 09:32:46 +0000 (10:32 +0100)
pdns/dnsdistdist/dnsdist-selectors-definitions.yml
pdns/dnsdistdist/dnsdist-settings-documentation-generator.py
pdns/dnsdistdist/docs/advanced/timedipsetrule.rst

index 10bda905ac50edbd2bf433e42a57a53f1185e87b..0c9fe64403ddcb8e1ea36fa455a2ad4c3fbe378c 100644 (file)
@@ -424,6 +424,7 @@ Set the ``source`` parameter to ``false`` to match against destination address i
 - name: "TimedIPSet"
   skip-cpp: true
   skip-rust: true
+  docs-is-class: true
   description: "Can be used to handle IP addresses differently for a certain time"
   parameters:
     - name: "set_name"
index 7e8bcb484c99748aac6c7e5ecfc978e2e95f473b..481157e9a1b75acf4d1d51ccc3f9d987acb5f17c 100644 (file)
@@ -136,7 +136,10 @@ def process_object(object_name, entries, entry_type, is_setting_struct=False, lu
         output += "\n"
 
     if lua_equivalent is not None:
-        output += f"Lua equivalent: :func:`{lua_equivalent}`\n\n"
+        if "docs-is-class" in entries and bool(entries["docs-is-class"]):
+            output += f"Lua equivalent: :class:`{lua_equivalent}`\n\n"
+        else:
+            output += f"Lua equivalent: :func:`{lua_equivalent}`\n\n"
 
     if "parameters" in entries:
         if not is_setting_struct:
index 400c5dc98d0ecc480516844a9fc8a02cfd34f8de..1de1648cb4a7167618ff8f15f9ca2dd002b0fed9 100644 (file)
@@ -9,11 +9,8 @@ This may be used to temporarily shunt traffic to another pool for example.
 :class:`TimedIPSetRule` creates an object to which native IP addresses can be
 added in :class:`ComboAddress` form.
 
-.. function:: TimedIPSetRule() -> TimedIPSetRule
-
-  Returns a :class:`TimedIPSetRule`.
-
 .. class:: TimedIPSetRule
+           TimedIPSetRule()
 
   Can be used to handle IP addresses differently for a certain time.