Skip to content
This repository has been archived by the owner on Aug 3, 2024. It is now read-only.

Commit

Permalink
doc: Fix a few minor ReST issues
Browse files Browse the repository at this point in the history
Sphinx was complaining about too-short title underlines.
  • Loading branch information
bgamari committed Aug 15, 2022
1 parent f07a405 commit 4248704
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion doc/common-errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
4 changes: 2 additions & 2 deletions doc/markup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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: ::
Expand Down

0 comments on commit 4248704

Please sign in to comment.