From 0fd3c6c7d5ae3962fb267a17f75481d9045ed8ac Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20=C4=8Cun=C3=A1t?= Date: Thu, 26 Jul 2018 17:35:19 +0200 Subject: [PATCH] hints docs: unify the descriptions of `hints.root()` MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit (Thanks to Láďa.) Also try to stress that hints.set() only takes a pair and not more. --- modules/hints/README.rst | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/modules/hints/README.rst b/modules/hints/README.rst index c28f56838..91424396f 100644 --- a/modules/hints/README.rst +++ b/modules/hints/README.rst @@ -58,11 +58,12 @@ Properties :param string pair: ``hostname address`` i.e. ``"localhost 127.0.0.1"`` :return: ``{ result: bool }`` - Add a hostname - address pair hint. + Add a hostname--address pair hint. .. note:: - If multiple addresses have been added for a name, all are returned in a forward query. + If multiple addresses have been added for a name (in separate ``hints.set()`` commands), + all are returned in a forward query. If multiple names have been added to an address, the last one defined is returned in a corresponding PTR query. @@ -73,12 +74,6 @@ Properties Remove a hostname - address pair hint. If address is omitted, all addresses for the given name are deleted. -.. function:: hints.root() - - :return: ``{ ['a.root-servers.net.'] = { '1.2.3.4', '5.6.7.8', ...}, ... }`` - - .. tip:: If no parameters are passed, returns current root hints set. - .. function:: hints.root_file(path) Replace current root hints from a zonefile. If the path is omitted, the compiled-in path is used, i.e. the root hints are reset to the default. @@ -90,6 +85,8 @@ Properties Replace current root hints and return the current table of root hints. + .. tip:: If no parameters are passed, it only returns current root hints set without changing anything. + Example: .. code-block:: lua -- 2.47.2