From: Otto Moerbeek <otto.moerbeek@open-xchange.com>
Date: Mon, 17 Aug 2020 13:42:07 +0000 (+0200)
Subject: Fix docs for DNSName::equal()
X-Git-Tag: rec-4.4.0-beta1~32^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F9388%2Fhead;p=thirdparty%2Fpdns.git

Fix docs for DNSName::equal()

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
---

diff --git a/pdns/recursordist/docs/lua-scripting/dnsname.rst b/pdns/recursordist/docs/lua-scripting/dnsname.rst
index c91671a730..0014afe8ff 100644
--- a/pdns/recursordist/docs/lua-scripting/dnsname.rst
+++ b/pdns/recursordist/docs/lua-scripting/dnsname.rst
@@ -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