New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-34962: make doctest in Doc now passes, and is enforced in CI #9806

Merged
merged 33 commits into from Oct 12, 2018

Conversation

Projects
None yet
5 participants
@matrixise
Contributor

matrixise commented Oct 11, 2018

@JulienPalard

This comment has been minimized.

Member

JulienPalard commented Oct 11, 2018

Needs python/docsbuild-scripts#59 to avoid a huge flood of warnings (yet the docs build properly at the end).

objects a little more gracefully:
.. testcode::
objects a little more gracefully: ::

This comment has been minimized.

@JulienPalard

JulienPalard Oct 11, 2018

Member

something: :: is equivalent to something::, but the shorter the better.

In reST :: touching a word is introducing a block and displaying :, while :: after a space is only introducing a block, not displaying :. So blah:: and blah: :: are the same. (Hence the usage of : :: in the french translation).

:meth:`~Match.group` method of the match object in the following manner:
.. doctest::
:meth:`~Match.group` method of the match object in the following manner: ::

This comment has been minimized.

@JulienPalard

JulienPalard Oct 11, 2018

Member

Looks strange to me to remove the doctest (.. doctest:: from line 1274) while fixing it (adding pair = ... line 1272)

This comment has been minimized.

@matrixise

matrixise Oct 11, 2018

Contributor

I didn't find the reason, but the evaluation context of the second block of code didn't contain the definition of pair :/

... result = some_function()
... assert result == 'the result'
>>> def some_function():
... instance = module.Foo()

This comment has been minimized.

@JulienPalard

JulienPalard Oct 11, 2018

Member

I'm surprised this works, why not keeping the indentation of the body of the function?

This comment has been minimized.

@matrixise

matrixise Oct 11, 2018

Contributor

maybe an error from my part.

@bedevere-bot

This comment has been minimized.

bedevere-bot commented Oct 11, 2018

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@JulienPalard

This comment has been minimized.

Member

JulienPalard commented Oct 11, 2018

I remove the DO-NOT-MERGE label as we're now having Sphinx 1.8.1 on docs.python.org.

Show resolved Hide resolved .travis.yml

matrixise added some commits Oct 11, 2018

@JulienPalard JulienPalard merged commit 859c068 into python:master Oct 12, 2018

5 checks passed

Azure Pipelines PR #20181011.58 succeeded
Details
bedevere/issue-number Issue number 34962 found
Details
bedevere/news News entry found in Misc/NEWS.d
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

yahya-abou-imran added a commit to yahya-abou-imran/cpython that referenced this pull request Nov 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment