From e7b4380d785ef641583171caabf4eef9cdff07c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Andr=C3=A9=20Tanner?= Date: Wed, 29 Jul 2020 11:13:53 +0200 Subject: doc: fix a couple of API doc warnings In restructured text double backquotes are used for inline literals. --- doc/text.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/text.rst') diff --git a/doc/text.rst b/doc/text.rst index 767bf29..8bbef5b 100644 --- a/doc/text.rst +++ b/doc/text.rst @@ -4,7 +4,7 @@ Text The core text management data structure which supports efficient modifications and provides a byte string interface. Text positions are represented as ``size_t``. Valid addresses are in range ``[0, -text_size(txt)]``. An invalid position is denoted by `EPOS`. Access to +text_size(txt)]``. An invalid position is denoted by ``EPOS``. Access to the non-contigiuos pieces is available by means of an iterator interface or a copy mechanism. Text revisions are tracked in an history graph. @@ -77,7 +77,7 @@ These functions advance to the next/previous grapheme cluster. .. note:: The grapheme cluster boundaries are currently not implemented according to `UAX#29 rules `_. Instead a base character followed by arbitrarily many combining - character as reported by `wcwidth(3)` are skipped. + character as reported by ``wcwidth(3)`` are skipped. .. doxygengroup:: iterator_char :content-only: @@ -105,7 +105,7 @@ A mark keeps track of a text position. Subsequent text changes will update all marks placed after the modification point. Reverting to an older text state will hide all affected marks, redoing the changes will restore them. -.. warning:: Due to an optimization cached modifications (i.e. no `text_snaphot` +.. warning:: Due to an optimization cached modifications (i.e. no ``text_snaphot`` was performed between setting the mark and issuing the changes) might not adjust mark positions accurately. -- cgit v1.2.3