Fix sphinx code-block types (syntax highlighting) in two docs#4783
Conversation
Codecov Report
@@ Coverage Diff @@
## master #4783 +/- ##
==========================================
+ Coverage 93.75% 95.92% +2.16%
==========================================
Files 113 113
Lines 25036 26758 +1722
Branches 2483 2982 +499
==========================================
+ Hits 23473 25668 +2195
+ Misses 1236 779 -457
+ Partials 327 311 -16
Continue to review full report at Codecov.
|
nicoddemus
left a comment
nicoddemus
left a comment
There was a problem hiding this comment.
Please remove the added $ as commented earlier. 👍
sure. just wanted to add a few more docs before making new commit |
|
No worries, take your time. Just wanted to let it be explicit here in the PR that we are waiting for new changes to be submitted. 👍 (easier for us maintainers to see which PRs require our attention) |
| It is possible to use fixtures using the ``getfixture`` helper:: | ||
| It is possible to use fixtures using the ``getfixture`` helper: | ||
|
|
||
| .. code-block:: text |
There was a problem hiding this comment.
I actually tried it first, but those files have doctest-syntax (valid python) and plain text as comments (valid for doctests). And no actual rst markup.
As as result there is no improvement in how they look on a web-page.
| If you then have a text file like this:: | ||
| If you then have a text file like this: | ||
|
|
||
| .. code-block:: text |
|
ready for review |
nicoddemus
left a comment
nicoddemus
left a comment
There was a problem hiding this comment.
Thanks a lot @gyermolenko!
|
Waiting for @Zac-HD's final comments (no rush). 👍 |
|
@Zac-HD feel free to do the honors! 👍 |
4 participants
Default sphinx highlight language here is
python, which is effective for all code-blocks after::.As a result we sometimes see erroneous highlights like these
Fixes are in two docs only (
doctest.rstandpythoncollection.rst) and if this PR is ok I could probably fix others.