]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
Fix docs for DNSName::equal() 9388/head
authorOtto Moerbeek <otto.moerbeek@open-xchange.com>
Mon, 17 Aug 2020 13:42:07 +0000 (15:42 +0200)
committerOtto Moerbeek <otto.moerbeek@open-xchange.com>
Tue, 18 Aug 2020 12:58:57 +0000 (14:58 +0200)
Since overloading Lua wrapper functions does not seem to be possible,
fix docs for DNSName:equal(). But note that == is defined for DNSNames.

Fixes #7510

pdns/recursordist/docs/lua-scripting/dnsname.rst

index c91671a730d2ad68f3d42987e89a87d02ec212f9..0014afe8ff8269439ef904b25d4bfc2bbcb10edd 100644 (file)
@@ -50,8 +50,10 @@ A small example of the functionality of a :class:`DNSName` is shown below:
   .. method:: DNSName:equal(name) -> bool
 
     Returns true when both names are equal for the DNS, i.e case insensitive.
+    
+    To compare two ``DNSName`` objects, use ``==``.
 
-    :param DNSName name: The name to compare against.
+    :param DNSName string: The name to compare against.
 
   .. method:: DNSName:isPartOf(name) -> bool