This repository was archived by the owner on Apr 15, 2025. It is now read-only.
Some suggestions#25
Closed
waveform80 wants to merge 5 commits into
Closed
Conversation
It's impossible to skip heading levels in reST (it's designed to avoid this as several of its output formats cannot skip levels either, due to recursive section structures).
reST permits heading underlines to be longer than the corresponding title, which some authors find convenient (i.e. it's fine to just use a full line of "=") https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections
The general style guide at https://docs.ubuntu.com/styleguide/en advises under the admonitions section that only the "warning" and "information" admonition callouts are permitted. Given "information" doesn't exist in reST, "note" is probably the next best thing. Changed "caution" to "warning" and removed "tip" and "important".
Using * as the image extension allows sphinx to pick the "best" image format for the output it's producing. For example, PNG for web, but embedded PS for PDF.
|
Hello! Thanks for this contribution. I'm afraid that this repository is being archived, and If you wish to submit this PR to that repository, it would be appreciated. Regardless, thanks for taking the time to make these suggestions. |
2 tasks
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Some suggestions for the reST documentation. Each commit is a separate suggestion; if any aren't desirable, I'm happy to rebase and remove them!