GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — [3.8] [doc] Fix erroneous backslashes in signatures and names (GH-23658) by andresdelfino · Pull Request #23828 · python/cpython

Conversation

@andresdelfino

@andresdelfino andresdelfino commented Dec 17, 2020 •
edited by miss-islington
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).

The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did..
(cherry picked from commit dcc997c)

Co-authored-by: Andre Delfino [email protected]

Automerge-Triggered-By: GH:Mariatta

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@andresdelfino
andresdelfino requested review from a team, 1st1, asvetlov and gpshead as code owners December 17, 2020 23:22
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Dec 17, 2020
@bedevere-bot bedevere-bot mentioned this pull request Dec 17, 2020
[doc] Fix erroneous backslashes in signatures and names #23658
Merged
@bedevere-bot bedevere-bot added skip issue skip news docs Documentation in the Doc dir awaiting review labels Dec 17, 2020
@andresdelfino
[3.8] [doc] Fix erroneous backslashes in signatures and names (python…
246dfee 
…GH-23658)

The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).

The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did..
(cherry picked from commit dcc997c)

Co-authored-by: Andre Delfino <[email protected]>
@andresdelfino
andresdelfino force-pushed the backport-dcc997c-3.8 branch from cbf73a3 to 246dfee Compare December 17, 2020 23:48
@andresdelfino

andresdelfino commented Dec 21, 2020

Copy link
Copy Markdown
Contributor Author

@Mariatta perhaps we can merge this?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
ghost
ghost approved these changes Dec 22, 2020
View reviewed changes

@ghost ghost left a comment

Copy link
Copy Markdown

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-bot bedevere-bot added awaiting core review and removed awaiting review labels Dec 22, 2020
Mariatta
Mariatta approved these changes Dec 22, 2020
View reviewed changes

@Mariatta Mariatta left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Dec 22, 2020
@Mariatta Mariatta added the 🤖 automerge label Dec 22, 2020
@miss-islington
miss-islington merged commit 02349e2 into python:3.8 Dec 22, 2020
@bedevere-bot bedevere-bot removed the awaiting merge label Dec 22, 2020
@JulienPalard

JulienPalard commented Jan 3, 2021

Copy link
Copy Markdown
Member

As in the 3.8 and 3.9 branch we don't use the newer Sphinx, this commit drops the backslashes :( I think this should be reverted, are you ok for a revert @andresdelfino ?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@JulienPalard JulienPalard mentioned this pull request Jan 3, 2021
Python escape codes (\n, \t etc.) are missing the '\' for 3.8 and 3.9 docs python/python-docs-theme#63
Closed
@andresdelfino
andresdelfino deleted the backport-dcc997c-3.8 branch January 3, 2021 13:22
@andresdelfino

andresdelfino commented Jan 3, 2021

Copy link
Copy Markdown
Contributor Author

@JulienPalard this commit doesn't affect how the doc is rendered for 3.8/3.9, but I think it's good to have consistency with master (to prevent conflicts for future commits).
gpshead reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@JulienPalard

JulienPalard commented Jan 3, 2021

Copy link
Copy Markdown
Member

@andresdelfino I just tried locally a first build on the top of 3.9, I have:

print(*objects, sep=' ', end='n', file=sys.stdout, flush=False)

and then reverted e89993c, build again, and I now have:

print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False)

so looks like e89993c made the backslash dissapear (see here in prod: https://docs.python.org/3.9/library/functions.html#print)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@andresdelfino

andresdelfino commented Jan 3, 2021

Copy link
Copy Markdown
Contributor Author

@JulienPalard oh, yes, you are right; this should be reverted. Sorry!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@JulienPalard JulienPalard mentioned this pull request Jan 4, 2021
[3.8] bpo-42822: Revert "[3.8] [doc] Fix erroneous backslashes in signatures and names (GH-23658)" #24093
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mariatta Mariatta Mariatta approved these changes
@1st1 1st1 Awaiting requested review from 1st1 1st1 is a code owner
@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner
@gpshead gpshead Awaiting requested review from gpshead gpshead is a code owner
+1 more reviewer
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@andresdelfino @JulienPalard @Mariatta @the-knights-who-say-ni @bedevere-bot @miss-islington
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.