Skip to content

Conversation

gyermolenko
Copy link
Contributor

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
image
image

Fixes are in two docs only (doctest.rst and pythoncollection.rst) and if this PR is ok I could probably fix others.

@codecov
Copy link

codecov bot commented Feb 13, 2019

Codecov Report

Merging #4783 into master will increase coverage by 2.16%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Flag Coverage Δ
#docs 29.61% <ø> (+0.12%) ⬆️
#doctesting 29.61% <ø> (+0.12%) ⬆️
#linting 29.61% <ø> (+0.12%) ⬆️
#linux 95.77% <ø> (?)
#nobyte 92.21% <ø> (+1.19%) ⬆️
#numpy 93.01% <ø> (+1.39%) ⬆️
#pexpect 42.07% <ø> (?)
#pluggymaster 93.73% <ø> (+0.83%) ⬆️
#py27 93.69% <ø> (+2.54%) ⬆️
#py34 91.69% <ø> (+0.81%) ⬆️
#py35 91.69% <ø> (+0.8%) ⬆️
#py36 91.71% <ø> (+0.81%) ⬆️
#py37 94.25% <ø> (+2.35%) ⬆️
#trial 93.01% <ø> (+1.39%) ⬆️
#windows 93.7% <ø> (-0.05%) ⬇️
#xdist 93.64% <ø> (+0.63%) ⬆️
Impacted Files Coverage Δ
src/_pytest/recwarn.py 94.01% <0%> (-4.35%) ⬇️
testing/code/test_code.py 94.2% <0%> (-1.32%) ⬇️
testing/test_skipping.py 98.17% <0%> (-0.51%) ⬇️
src/_pytest/deprecated.py 100% <0%> (ø) ⬆️
testing/logging/test_reporting.py 100% <0%> (ø) ⬆️
testing/deprecated_test.py 100% <0%> (ø) ⬆️
src/_pytest/python.py 92.82% <0%> (+0.02%) ⬆️
src/_pytest/fixtures.py 97.91% <0%> (+0.13%) ⬆️
testing/test_mark.py 99.37% <0%> (+0.31%) ⬆️
testing/test_assertrewrite.py 83.48% <0%> (+0.45%) ⬆️
... and 33 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8726be2...6e1ee08. Read the comment docs.

Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the added $ as commented earlier. 👍

@gyermolenko
Copy link
Contributor Author

Please remove the added $ as commented earlier. 👍

sure. just wanted to add a few more docs before making new commit

@nicoddemus
Copy link
Member

nicoddemus commented Feb 14, 2019

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rst instead of text?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rst instead of text?

@gyermolenko
Copy link
Contributor Author

ready for review

Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @gyermolenko!

@nicoddemus
Copy link
Member

Waiting for @Zac-HD's final comments (no rush). 👍

Copy link
Member

@Zac-HD Zac-HD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 😎

@nicoddemus
Copy link
Member

@Zac-HD feel free to do the honors! 👍

@Zac-HD Zac-HD merged commit c8a87e4 into pytest-dev:master Feb 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants