docs: tutorial/introduction doesn't mention toggle of prompts

[jfine2358]

BPO	34451
Nosy	@rhettinger, @encukou, @miss-islington, @RJ722, @jfine2358, @davidmrdavid, @dhoekstra2000, @thmsdnnr
PRs	bpo-34451: Document prompt and output toggle feature in html tutorial #27105 [3.10] bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105) #29119 [3.9] bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105) #29120

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2021-11-23.15:44:04.759>
created_at = <Date 2018-08-21.18:50:18.611>
labels = ['easy', '3.8', '3.9', '3.10', 'type-feature', 'docs']
title = "docs: tutorial/introduction doesn't mention toggle of prompts"
updated_at = <Date 2021-11-23.15:44:04.758>
user = 'https://github.com/jfine2358'

bugs.python.org fields:

activity = <Date 2021-11-23.15:44:04.758>
actor = 'petr.viktorin'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-11-23.15:44:04.759>
closer = 'petr.viktorin'
components = ['Documentation']
creation = <Date 2018-08-21.18:50:18.611>
creator = 'jfine2358'
dependencies = []
files = []
hgrepos = []
issue_num = 34451
keywords = ['patch', 'easy']
message_count = 9.0
messages = ['323839', '381920', '381928', '384472', '393105', '402262', '404581', '404593', '404594']
nosy_count = 9.0
nosy_names = ['rhettinger', 'petr.viktorin', 'docs@python', 'miss-islington', 'RJ722', 'jfine2358', 'davidmrdavid', 'dhoekstra', 'thmsdnnr']
pr_nums = ['27105', '29119', '29120']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue34451'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

[jfine2358]

Interactive code examples need the prompt to be stripped, before copy-and-paste. This is explained in https://docs.python.org/3/tutorial/introduction.html

But this page does not tell us about the [>>>] prompt-toggle at top of each interactive code example. This caused a user error, reported in https://mail.python.org/pipermail/python-ideas/2018-August/052869.html.

The [>>>] toggle isn't in the Python 2.7 docs, so nothing to fix there!

[rhettinger]

The toggle option is only in the HTML version with javascript enabled. It would apply to PDF renderings or CHM files etc.

[rhettinger]

• It would apply to PDF renderings or CHM files etc.
  + We wouldn't the the proposed text to be visible in PDF renderings or CHM files etc.

[davidmrdavid]

Hi folks! I'm interested in contributing to this issue, but I'm unsure about the context.

Can >>>> prompts be toggled on-and-off in the docs? I do not see that option. I read that this is possible in javascript-enabled versions of the site, but isn't that the default? If so, I have JS enabled and I do not see how to toggle them out :) . Maybe that's part of what we need to fix as well.

Thanks for your time!

[dhoekstra2000]

Hi David! There is a button marked '>>>' in the top right corner of code blocks with Interactive code examples. This toggles between the interaction as it would appear in a terminal and a mode where only the input is listed without the '>>>'.

See for example the second block on https://docs.python.org/3/tutorial/introduction.html

[thmsdnnr]

I added a pull request to attempt to fix this issue. It received a label but no review and has gone stale, so I am sending out a ping.

[encukou]

New changeset 5a14f71 by Thomas in branch 'main':
bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105)
5a14f71

[encukou]

New changeset 00ddc1f by Miss Islington (bot) in branch '3.10':
bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105) (GH-29119)
00ddc1f

[encukou]

New changeset bfa4237 by Miss Islington (bot) in branch '3.9':
bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105) (GH-29120)
bfa4237