DOC: Fix character after trailing backticks #19233
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
Having charter directly after prevent docutils/sphinx from closing the interpreted-text/verbatim. One must use escaped space to have no spaces, (`\ `) double in r-docstring `\\ `. See spec, and confirmed this is what happens when building the doc. https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#character-level-inline-markup-1 Change also singe backtick to double where relevant.
Carreau
requested review from
larsoner,
ilayn,
ev-br and
steppi
as code owners
|
Some relevant pages, if you want to see the current incorrect layout: https://docs.scipy.org/doc/scipy/reference/generated/scipy.linalg.ordqz.html#scipy.linalg.ordqz |
j-bowhay
added
the
Documentation
j-bowhay
approved these changes
Sep 13, 2023
There was a problem hiding this comment.
Thanks @Carreau! Just a friendly reminder about skipping unneeded CI runs for these doc only changes
https://docs.scipy.org/doc/scipy/dev/contributor/continuous_integration.html#skipping
|
Yes sorry, i keep thinking about it after pushing .
…On Wed, Sep 13, 2023 at 12:13 Jake Bowhay ***@***.***> wrote:
Merged #19233 <#19233> into main.
—
Reply to this email directly, view it on GitHub
<#19233 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AACR5T2LWTRHLYYKXBNXYGDX2GBOLANCNFSM6AAAAAA4WC3FSA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
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.
Having charter directly after prevent docutils/sphinx from closing the interpreted-text/verbatim. One must use escaped space to have no spaces, (
\) double in r-docstring\\.See spec, and confirmed this is what happens when building the doc.
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#character-level-inline-markup-1
Change also singe backtick to double where relevant.