X Tutup
The Wayback Machine - https://web.archive.org/web/20220505115859/https://github.com/python/cpython/issues/81039
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.

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

f-string '=' debugging output needs to be documented #81039

Open
ericvsmith opened this issue May 8, 2019 · 5 comments
Open

f-string '=' debugging output needs to be documented #81039

ericvsmith opened this issue May 8, 2019 · 5 comments
Labels
3.8 docs type-feature

Comments

@ericvsmith
Copy link

@ericvsmith ericvsmith commented May 8, 2019

BPO 36858
Nosy @ericvsmith, @Mariatta, @tmblweed

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 = None
created_at = <Date 2019-05-08.20:36:56.010>
labels = ['type-feature', '3.8', 'docs']
title = "f-string '=' debugging output needs to be documented"
updated_at = <Date 2019-08-21.18:19:36.043>
user = 'https://github.com/ericvsmith'

bugs.python.org fields:

activity = <Date 2019-08-21.18:19:36.043>
actor = 'syadlapalli'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-05-08.20:36:56.010>
creator = 'eric.smith'
dependencies = []
files = []
hgrepos = []
issue_num = 36858
keywords = []
message_count = 4.0
messages = ['341941', '342018', '342082', '350101']
nosy_count = 4.0
nosy_names = ['eric.smith', 'docs@python', 'Mariatta', 'syadlapalli']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue36858'
versions = ['Python 3.8']
@ericvsmith
Copy link
Author

@ericvsmith ericvsmith commented May 8, 2019

There are two problems here: what to call this feature, and where to put it.

The current f-string documentation is in Doc/reference/lexical_analysis.rst, which I'm not sure is the best place to add discussion about how this feature works. This feature is run-time behavior, and goes beyond what the lexer documentation should show.

@ericvsmith ericvsmith added the 3.8 label May 8, 2019
@ericvsmith ericvsmith added docs type-feature labels May 8, 2019
@Mariatta
Copy link
Sponsor

@Mariatta Mariatta commented May 10, 2019

Related issue where the '=' debug mode was implemented: https://bugs.python.org/issue36817

@Mariatta
Copy link
Sponsor

@Mariatta Mariatta commented May 10, 2019

Perhaps it can be added under Tutorial?

https://docs.python.org/3/tutorial/inputoutput.html#formatted-string-literals

@tmblweed
Copy link

@tmblweed tmblweed mannequin commented Aug 21, 2019

Hello,

I'd like to work on this and will take a look.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
@slateny slateny mentioned this issue May 4, 2022
Open
@serhiy-storchaka
Copy link

@serhiy-storchaka serhiy-storchaka commented May 5, 2022

Not everything should be in the tutorial Otherwise, the tutorial will be too heavy and no one will finish it.

It is an advanced feature. It is not necessary for beginner.

But it would be nice to have the documentation for f-string expressions (less dry than in the language specification), str.format(), built-in format() and printf-style formatting in one place. Currently it is scattered across different files and even different directories.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.8 docs type-feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ericvsmith @serhiy-storchaka @Mariatta
X Tutup