]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
docs: Fix formatting of Lua2 backend API
authorGert van Dijk <gertvdijk@gmail.com>
Sun, 31 Mar 2019 17:25:21 +0000 (19:25 +0200)
committerGert van Dijk <gertvdijk@gmail.com>
Mon, 8 Apr 2019 10:15:07 +0000 (12:15 +0200)
Without a blank line between the paragraphs in the descriptions of
RST description lists [1], the list items will not render as list items,
but as a long single paragraph.

[1]: http://docutils.sourceforge.net/docs/user/rst/quickref.html#definition-lists

docs/backends/lua2.rst

index 7b079a0d4e684414a476339401fcff7e1b81ec17..e12c1441e1d3bca507d04b1fd24fce3fd17c27ee 100644 (file)
@@ -46,6 +46,7 @@ INPUT:
 
 OUTPUT:
  Expects a array which has tables with following keys:
+
  - DNSName name - resource record name (can also be string)
  - string type - type of resource record (can also be QType or valid integer)
  - string content - resource record content
@@ -85,6 +86,7 @@ INPUT:
 
 OUTPUT:
  Return false if not supported or found, otherwise expects a table with keys:
+
  - string account - Associated account of this domain (default: <empty>)
  - string kind - Domain kind (NATIVE,MASTER,SLAVE) (default: NATIVE)
  - int id - Associated domain ID (default: -1)
@@ -147,6 +149,7 @@ INPUT:
 
 OUTPUT:
  Return false if not found or supported, otherwise expects array of tables with keys:
+
  - int id - Key ID
  - int flags - Key flags
  - bool active - Is key active
@@ -165,6 +168,7 @@ INPUT:
 
 OUTPUT:
  Table with keys:
+
  - unhashed - DNSName of the unhashed relative to domain
  - before - (hashed) name of previous record relative to domain
  - after - (hashed) name of next record relative to domain