Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix code-block in zoneinfo #20201

Merged
merged 1 commit into from
May 19, 2020
Merged

Fix code-block in zoneinfo #20201

merged 1 commit into from
May 19, 2020

Conversation

asottile
Copy link
Contributor

@asottile asottile commented May 19, 2020 •
edited by miss-islington
Loading 

Warning, treated as error:
/tmp/code/Doc/library/zoneinfo.rst:303:Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

    >>> a = ZoneInfo("Europe/Berlin")
    >>> b = pickle.loads(europe_berlin_pkl)
    >>> a is b
    True

Automerge-Triggered-By: @pganssle

@asottile
Fix code-block in zoneinfo
c579a17 
Warning, treated as error:
/tmp/code/Doc/library/zoneinfo.rst:303:Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

    >>> a = ZoneInfo("Europe/Berlin")
    >>> b = pickle.loads(europe_berlin_pkl)
    >>> a is b
    True
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 19, 2020
@asottile
Copy link
Contributor Author

CC @ambv @pganssle this is breaking the 3.9.0b1 build for deadsnakes

@ambv
Copy link
Contributor

ambv commented May 19, 2020

Good catch, sorry for your trouble. Since the tag is already published, you'll have to cherrypick this for your build, is that okay?

@asottile
Copy link
Contributor Author

Good catch, sorry for your trouble. Since the tag is already published, you'll have to cherrypick this for your build, is that okay?

yep! already applied it as a local patch which'll get removed for b1 🎉

@pganssle
Copy link
Member

Thanks for the PR!

Does it not seem imprudent to enforce a more strict docs build on a redistribution than on upstream? Seems to me the feedback loop would be annoyingly long. Should we change our CI to catch these issues?

@miss-islington miss-islington merged commit 9095f76 into python:master May 19, 2020
@pganssle pganssle added the needs backport to 3.9 only security fixes label May 19, 2020
@miss-islington
Copy link
Contributor

Thanks @asottile for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

@asottile asottile deleted the fix_code_block_zoneinfo branch May 19, 2020 02:03
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 19, 2020
@asottile @miss-islington
Fix code-block in zoneinfo (pythonGH-20201)
2bfb539 
```
Warning, treated as error:
/tmp/code/Doc/library/zoneinfo.rst:303:Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

    >>> a = ZoneInfo("Europe/Berlin")
    >>> b = pickle.loads(europe_berlin_pkl)
    >>> a is b
    True
```
(cherry picked from commit 9095f76)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
@bedevere-bot
Copy link

GH-20204 is a backport of this pull request to the 3.9 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label May 19, 2020
@ambv
Copy link
Contributor

ambv commented May 19, 2020

The full release docs build is rather longish because it builds letter and A4 PDFs too with TeX etc. etc. So we only do that for RCs and stable releases. Making a minimal HTML build every time seems like something we want to have.

@pganssle
Copy link
Member

@ambv Ah, thanks. I was thinking this was a build with -W or something (though come to think of it the backport for zoneinfo includes -W -n in the CI), in which case it would just be a matter of turning on that option, but It seems to me that -W wouldn't catch this, and -W -n, even if it would catch this, is not something we can turn on easily:

$ SPHINXOPTS="-W -a -j auto -n --keep-going" make html 1>/dev/null 2>error.log
$ wc -l error.log
6916 error.log

Thanks!

miss-islington added a commit that referenced this pull request May 19, 2020
@miss-islington @asottile
Fix code-block in zoneinfo (GH-20201)
20736b3 
```
Warning, treated as error:
/tmp/code/Doc/library/zoneinfo.rst:303:Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

    >>> a = ZoneInfo("Europe/Berlin")
    >>> b = pickle.loads(europe_berlin_pkl)
    >>> a is b
    True
```
(cherry picked from commit 9095f76)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
arturoescaip pushed a commit to arturoescaip/cpython that referenced this pull request May 24, 2020
@asottile @arturoescaip
Fix code-block in zoneinfo (pythonGH-20201)
af3ee9d 
```
Warning, treated as error:
/tmp/code/Doc/library/zoneinfo.rst:303:Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

    >>> a = ZoneInfo("Europe/Berlin")
    >>> b = pickle.loads(europe_berlin_pkl)
    >>> a is b
    True
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pganssle pganssle pganssle approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@asottile @ambv @pganssle @miss-islington @bedevere-bot @the-knights-who-say-ni