diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2022-08-15 14:09:50 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2022-08-15 14:33:05 -0400 |
| commit | 4248704596d01753c9a776ebedf5cc598a883e28 (patch) | |
| tree | 8882fe0438db271fc8d1a1f54f1637c09ace1e0b /doc | |
| parent | f07a4059efcde05fd26b33a8c902930d3ad90379 (diff) | |
doc: Fix a few minor ReST issues
Sphinx was complaining about too-short title underlines.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/common-errors.rst | 2 | ||||
| -rw-r--r-- | doc/markup.rst | 4 |
2 files changed, 3 insertions, 3 deletions
diff --git a/doc/common-errors.rst b/doc/common-errors.rst index 9afa4ea7..504ee886 100644 --- a/doc/common-errors.rst +++ b/doc/common-errors.rst @@ -7,7 +7,7 @@ Common Errors This is probably caused by the ``-- | xxx`` comment not following a declaration. I.e. use ``-- xxx`` instead. See :ref:`top-level-declaration`. ``parse error on input ‘-- $ xxx’`` ----------------------------------- +----------------------------------- You've probably commented out code like:: diff --git a/doc/markup.rst b/doc/markup.rst index 55ae3cb3..bae615cb 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -950,8 +950,8 @@ apostrophes themselves: to hyperlink ``foo'`` one would simply type -- | A prefix operator @'(++)'@ and an infix identifier @'`elem`'@. -Emphasis, Bold and Monospaced styled Text -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Emphasis, Bold and Monospaced Styled Text +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Text can be emphasized, made bold (strong) or monospaced (typewriter font) by surrounding it with slashes, double-underscores or at-symbols: :: |