From e47f81af7564d06ba8ec552170fad55fc2dd6bed Mon Sep 17 00:00:00 2001 From: currite Date: Mon, 4 May 2020 01:07:52 +0200 Subject: configuration-overview: fix comment command Delete sentence saying it only applies to subsections, as that is not correct. Fix some format mistakes too. --- docs/configuration-overview.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'docs/configuration-overview.rst') diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index 51091d9d..cbc4ab3b 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -247,11 +247,10 @@ Comment Add comment as an annotation to a configuration node. - The ``comment` command allows you to insert a comment above the - ```` configuration section. Comments are enclosed with - ``/*`` and ``*/`` as open/close delimiters. A ``comment`` cannot be - used at the top of the configuration hierarchy, only on subsections. - Comments need to be commited, just like other config changes. + The ``comment`` command allows you to insert a comment above the + ```` configuration section. When shown, comments are + enclosed with ``/*`` and ``*/`` as open/close delimiters. Comments + need to be commited, just like other config changes. To remove an existing comment from your current configuration, specify an empty string enclosed in double quote marks (``""``) as -- cgit v1.2.3