]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
dnsdist: Fix a few typos in the documentation 8658/head
authorRemi Gacogne <remi.gacogne@powerdns.com>
Tue, 24 Dec 2019 15:23:17 +0000 (16:23 +0100)
committerRemi Gacogne <remi.gacogne@powerdns.com>
Tue, 24 Dec 2019 15:23:17 +0000 (16:23 +0100)
pdns/dnsdistdist/docs/reference/comboaddress.rst
pdns/dnsdistdist/docs/reference/dnsnameset.rst
pdns/dnsdistdist/docs/reference/kvs.rst

index 7ecdfa6545f0055a71a299a6fcd0824e063e8f1f..79d05ad99debe92813598494ea971c22d2d4d0b0 100644 (file)
@@ -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
index f0797d8baab94a303b16a97e929f1cad0fbac6a6..0bcf8a8c9b68887a6d02b0b36c96ea7c2926ad1c 100644 (file)
@@ -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.
index 100e2c4e580fe501ab52619d2ddd2f16f07a9c7e..47e69945824f3b23c9d09f66d3cad84d678ea7ad 100644 (file)
@@ -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.