DOC: A few documentation fix-ups #569
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
Add missing link reference.
Section title in text (used as an example) was slightly out of sync with the actual section title.
Rendered cell used Python syntax highlighting by default, rather than a pure literal-block with no syntax highlighting.
The pdf-building docs use a \{content\} directive to list section
headings within the document to highlight two different ways of
building pdfs. Change depth from (1) to (2) so that the relevant
headings are shown.
Alternatively, it might be better to replace the content directive
entirely as it adds a title and the doc title, neither of which is
necessary in this case.
|
This all looks good to me - is it ready for a merge? Thanks for the improvements! |
|
Yup, ready for merge! The PR description highlights something that may or may not be an issue with the parsing of a code block, but there's nothing else actionable related to that in this PR. |
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.
A few fixes to documentation from another read-through to catch up with all the exciting features. All very minor text/formatting changes, though the change in d46d7d9 warrants a closer look:
The main issue there is that a literal block (with no language specifier/info string) in content/citations.md is using Python syntax highlighting, i.e. this:
Renders with Python syntax highlighting
I would've expected the fenced section to have no syntax highlighting at all - in fact, this is the case for some of the fenced sections demonstrating the
{cite}role further up in the same document. I'm not sure whether this behavior is unexpected, but it did surprise me.