]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
Document setTag(Array) behaviour 10601/head
authorSander Steffann <sander@steffann.nl>
Tue, 20 Jul 2021 11:02:41 +0000 (13:02 +0200)
committerGitHub <noreply@github.com>
Tue, 20 Jul 2021 11:02:41 +0000 (13:02 +0200)
Explicitly document that setTag and setTagArray do not overwrite existing tag values.

pdns/dnsdistdist/docs/reference/dq.rst

index 546e1d7c9baec88e86e805b1c5bb97a34b3d178c..76a432a1efb1d6e0971fdc456d47773b0c1bf3ef 100644 (file)
@@ -222,14 +222,16 @@ This state can be modified from the various hooks.
   .. method:: DNSQuestion:setTag(key, value)
 
     Set a tag into the DNSQuestion object.
-
+    This function will not overwrite an existing tag. If the tag already exists it will keep its original value.
+  
     :param string key: The tag's key
     :param string value: The tag's value
 
   .. method:: DNSQuestion:setTagArray(tags)
 
     Set an array of tags into the DNSQuestion object.
-
+    This function will not overwrite an existing tag. If the tag already exists it will keep its original value.
+  
     :param table tags: A table of tags, using strings as keys and values
 
   .. method:: DNSQuestion:setTrailingData(tail) -> bool