docs: remove line block markup #2729
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I don't see a point in using [line blocks][1] anywhere in the documentation. Note that mandoc consequently renders it with a `<pre>` tag which looks ugly on [man.archlinux.org][2]. Also simplified the URL in `index.rst` which can be written verbatim without any special markup. See this [archmanweb issue][3] for details. [1]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [2]: https://man.archlinux.org/man/archinstall.1 [3]: https://gitlab.archlinux.org/archlinux/archmanweb/-/issues/49#note_213730
svartkanin
approved these changes
Oct 13, 2024
|
Thanks for the improvements |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I don't see a point in using line blocks anywhere in the documentation. Note that mandoc consequently renders it with a
<pre>tag which looks ugly on man.archlinux.org.Also simplified the URL in
index.rstwhich can be written verbatim without any special markup.See this archmanweb issue for details.