Skip to content

bpo-35821: Fix restructuredtext code formatting in logging.rst #29963

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

Merged
merged 1 commit into from
Dec 7, 2021

Conversation

Fidget-Spinner
Copy link
Member

@Fidget-Spinner Fidget-Spinner commented Dec 7, 2021

@Fidget-Spinner
Copy link
Member Author

@vsajip GH-29841 caused rstlint (and azure pipelines) to fail. Example:

Starting: Build documentation
==============================================================================
Task         : Command line
Description  : Run a command line script using Bash on Linux and macOS and cmd.exe on Windows
Version      : 2.182.0
Author       : Microsoft Corporation
Help         : https://docs.microsoft.com/azure/devops/pipelines/tasks/utility/command-line
==============================================================================
Generating script.
Script contents:
make check html PYTHON=python
========================== Starting Command Output ===========================
/usr/bin/bash --noprofile --norc /home/vsts/work/_temp/f6f6a565-c086-4198-8061-0fd6560797f2.sh
python tools/rstlint.py -i tools -i ./venv -i README.rst
[2] library/logging.rst:84: default role used
[2] library/logging.rst:87: default role used
[2] library/logging.rst:88: default role used
[2] library/logging.rst:89: default role used
4 problems with severity 2 found.
make: *** [Makefile:216: check] Error 1
##[error]Bash exited with code '2'.
Finishing: Build documentation

@Fidget-Spinner
Copy link
Member Author

Merging this to unblock other things. Thanks @bateller for taking a look.

@Fidget-Spinner Fidget-Spinner merged commit c7e7a4b into python:main Dec 7, 2021
@miss-islington
Copy link
Contributor

Thanks @Fidget-Spinner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 7, 2021
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 7, 2021
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Dec 7, 2021
@bedevere-bot
Copy link

GH-29965 is a backport of this pull request to the 3.10 branch.

@bedevere-bot
Copy link

GH-29966 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 Dec 7, 2021
@Fidget-Spinner Fidget-Spinner deleted the fix_rst branch December 7, 2021 15:27
miss-islington added a commit that referenced this pull request Dec 7, 2021
…GH-29963) (GH-29965)

(cherry picked from commit c7e7a4b)


Co-authored-by: Ken Jin <[email protected]>

Automerge-Triggered-By: GH:Fidget-Spinner
miss-islington added a commit that referenced this pull request Dec 7, 2021
@vsajip
Copy link
Member

vsajip commented Dec 7, 2021

caused rstlint (and azure pipelines) to fail.

@Fidget-Spinner Sorry, missed that. How come the Docs build on GH-29841 reported success? I didn't check the Azure build, because often seems to fail for no apparent reason and with no diagnostics 😞

@Fidget-Spinner
Copy link
Member Author

@vsajip no worries! Docs build doesn't seem to run rstlint. I suspect that's because rstlint previously generated many false positives, so we disabled that for normal docs builds. @JulienPalard probably knows more about this than I do.

@vsajip
Copy link
Member

vsajip commented Dec 7, 2021

So the error showed only on the Azure build. or somewhere else as well?

@Fidget-Spinner
Copy link
Member Author

Fidget-Spinner commented Dec 7, 2021

Only on the Azure build. GH docs builds were fine.

@JulienPalard
Copy link
Member

Adding a bit of context:

Previously make suspicious was throwing a lot of false positives and was slow, so I disabled it and now I'm trying to replace make suspicious by make check which is fast and should not give false positives (or at least, reported false positives should be considered a bug, not the norm).

I missed the fact that the azure pipeline was ~ignored and the .github/workflow/doc was not running make check. Victor fixed it yesterday by adding make check to the github workflow \o/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants