From 5913c944d9737e2f9a30f3ddfe95b166232d93ca Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Tue, 23 Jun 2020 22:40:16 +0200 Subject: [PATCH] Make a note in the docd about bold/italic etc formatting --- docs/source/interface.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/interface.rst b/docs/source/interface.rst index 005efd92..5502ae22 100644 --- a/docs/source/interface.rst +++ b/docs/source/interface.rst @@ -58,6 +58,10 @@ The editor also has a minimal set of keywords used for setting tags and referenc "``% Synopsis: text...``", "A synopsis comment. Shows up in the Synopsis column of the Outline View, but is otherwise treated as a comment." "``@keyword: value``", "A keyword argument followed by a value, or a comma separated list of values." +.. note:: + The bold/italic/strikethrough formatting tags do not allow spaces between the words and the tag itself. + That is, ``**text**`` is valid, ``**text **`` is not. + The editor and viewer also supports markdown standard hard line breaks, and preserves non-breaking spaces. A hard line break is achieved by leaving two or more spaces at the end of the line. Alternatively, the user can press :kbd:`Ctrl-K, Return` to insert this.