From: Remi Gacogne <remi.gacogne@powerdns.com>
Date: Tue, 24 Dec 2019 15:23:17 +0000 (+0100)
Subject: dnsdist: Fix a few typos in the documentation
X-Git-Tag: auth-4.3.0-beta1~51^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F8658%2Fhead;p=thirdparty%2Fpdns.git

dnsdist: Fix a few typos in the documentation
---

diff --git a/pdns/dnsdistdist/docs/reference/comboaddress.rst b/pdns/dnsdistdist/docs/reference/comboaddress.rst
index 7ecdfa6545..79d05ad99d 100644
--- a/pdns/dnsdistdist/docs/reference/comboaddress.rst
+++ b/pdns/dnsdistdist/docs/reference/comboaddress.rst
@@ -3,10 +3,10 @@
 ComboAddress
 ============
 
-IP addresses are moved around in a native format, called a ComboAddress.
+IP addresses are moved around in a native format, called a :class:`ComboAddress`.
 ComboAddresses can be IPv4 or IPv6, and unless you want to know, you don't need to.
 
-.. function:: newCA(address) -> :class:`ComboAddress`
+.. function:: newCA(address) -> ComboAddress
 
   Returns a :class:`ComboAddress` based on ``address``
 
@@ -49,7 +49,7 @@ ComboAddresses can be IPv4 or IPv6, and unless you want to know, you don't need
   .. method:: ComboAddress:mapToIPv4() -> ComboAddress
 
     Convert an IPv4 address mapped in a v6 one into an IPv4.
-    Returns a new ComboAddress
+    Returns a new :class:`ComboAddress`
 
   .. method:: ComboAddress:tostring() -> string
                    ComboAddress:toString() -> string
@@ -63,7 +63,7 @@ ComboAddresses can be IPv4 or IPv6, and unless you want to know, you don't need
 
   .. method:: ComboAddress:truncate(bits)
 
-    Truncate the ComboAddress to the specified number of bits.
+    Truncate the :class:`ComboAddress` to the specified number of bits.
     This essentially zeroes all bits after ``bits``.
 
     :param int bits: Amount of bits to truncate to
diff --git a/pdns/dnsdistdist/docs/reference/dnsnameset.rst b/pdns/dnsdistdist/docs/reference/dnsnameset.rst
index f0797d8baa..0bcf8a8c9b 100644
--- a/pdns/dnsdistdist/docs/reference/dnsnameset.rst
+++ b/pdns/dnsdistdist/docs/reference/dnsnameset.rst
@@ -29,7 +29,7 @@ Functions and methods of a ``DNSNameSet``
 
     Adds the name to the set.
 
-    :param DNSName name The name to add.
+    :param DNSName name: The name to add.
 
   .. method:: DNSNameSet:empty() -> bool
 
@@ -41,7 +41,7 @@ Functions and methods of a ``DNSNameSet``
 
   .. method:: DNSNameSet:toString() -> string
 
-    Returns a human-readable form of the DNSName.
+    Returns a human-readable form of the DNSNameSet.
 
   .. method:: DNSNameSet:size() -> int
 
@@ -51,10 +51,10 @@ Functions and methods of a ``DNSNameSet``
 
     Removes the name from the set. Returns the number of deleted elements.
 
-   :param DNSName name The name to remove.
+    :param DNSName name: The name to remove.
 
   .. method:: DNSNameSet:check(name) -> bool
 
     Returns true if the set contains the name.
 
-   :param DNSname name The name.
+    :param DNSName name: The name to check.
diff --git a/pdns/dnsdistdist/docs/reference/kvs.rst b/pdns/dnsdistdist/docs/reference/kvs.rst
index 100e2c4e58..47e6994582 100644
--- a/pdns/dnsdistdist/docs/reference/kvs.rst
+++ b/pdns/dnsdistdist/docs/reference/kvs.rst
@@ -9,7 +9,7 @@ A lookup into a key value store can be done via the :func:`KeyValueStoreLookupRu
 the :func:`KeyValueStoreLookupAction` action, using the usual selectors to match the incoming
 queries for which the lookup should be done.
 
-The first step is to get a :ref:`KeyValueStore` object via one of the following functions:
+The first step is to get a :class:`KeyValueStore` object via one of the following functions:
 
  * :func:`newCDBKVStore` for a CDB database ;
  * :func:`newLMDBKVStore` for a LMDB one.