bpo-29526 Add reference to help('FORMATTING') in format() builtin #166

aktech · 2017-02-19T06:21:47Z

>>> import pprint
>>> pprint.pprint(format.__doc__)
('Return value.__format__(format_spec)\n' 
 '\n'
 'format_spec defaults to the empty string.\n'
 '\n'
 "See help('FORMATTING') for description.")

the-knights-who-say-ni · 2017-02-19T06:21:48Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow these steps to rectify the issue:

Sign the PSF contributor agreement
Wait at least one US business day and then check "Your Details" on bugs.python.org to see if your account has been marked as having signed the CLA (the delay is due to a person having to manually check your signed CLA)
Reply here saying you have completed the above steps

Thanks again to your contribution and we look forward to looking at it!

serhiy-storchaka · 2017-02-19T08:00:34Z

Python/clinic/bltinmodule.c.h

@@ -77,7 +77,9 @@ PyDoc_STRVAR(builtin_format__doc__,
 "\n"
 "Return value.__format__(format_spec)\n"
 "\n"
-"format_spec defaults to the empty string");
+"format_spec defaults to the empty string.\n"


Python/clinic/bltinmodule.c.h is generated file. Changes should be made in Python/bltinmodule.c. Run make clinic for regenerating Python/clinic/bltinmodule.c.h.

Oh, I see. Thanks, fixing now.

aktech · 2017-03-28T17:09:19Z

ping @serhiy-storchaka

terryjreedy · 2017-03-28T18:40:23Z

Python/bltinmodule.c

@@ -578,12 +578,13 @@ format as builtin_format

 Return value.__format__(format_spec)

-format_spec defaults to the empty string
+format_spec defaults to the empty string.
+See help('FORMATTING') for description.


The initial section of help('FORMATTNG') describes replacement fields and everything but format specs. This could confuse a beginner. So I suggest as an alternative:
See the Format Specification Mini-Language section of help('FORMATTING').

I agree with @terryjreedy that the pointer to the other docs isn't quite right. My suggestion would be to replace the second added sentence with:

See the Format Specification Mini-Language section of help('FORMATTING') for details.

ncoghlan

Hi @aktech, sorry for the long delay on the review here. Would you mind taking a look at the suggested amendments to the precise wording?

ncoghlan · 2017-05-27T05:26:59Z

Python/bltinmodule.c

@@ -578,12 +578,13 @@ format as builtin_format

 Return value.__format__(format_spec)

-format_spec defaults to the empty string
+format_spec defaults to the empty string.
+See help('FORMATTING') for description.


I agree with @terryjreedy that the pointer to the other docs isn't quite right. My suggestion would be to replace the second added sentence with:

See the Format Specification Mini-Language section of help('FORMATTING') for details.

ncoghlan · 2017-05-28T05:03:50Z

Added the sprint label, as this PR was submitted at the PyCon Pune 2017 core development sprint.

codecov · 2017-05-28T09:00:13Z

Codecov Report

Merging #166 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #166      +/-   ##
==========================================
+ Coverage   83.41%   83.41%   +<.01%     
==========================================
  Files        1367     1367              
  Lines      345516   345516              
==========================================
+ Hits       288203   288211       +8     
+ Misses      57313    57305       -8

Impacted Files	Coverage Δ
Lib/threading.py	`82.69% <0%> (-0.18%)`	⬇️
Lib/zipfile.py	`88.68% <0%> (-0.16%)`	⬇️
Lib/test/test_ssl.py	`88% <0%> (-0.13%)`	⬇️
Lib/pydoc.py	`62% <0%> (+0.06%)`	⬆️
Lib/test/test_random.py	`98.64% <0%> (+0.19%)`	⬆️
Lib/nntplib.py	`81.57% <0%> (+0.35%)`	⬆️
Lib/heapq.py	`98.85% <0%> (+3.81%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1cf93a7...1824378. Read the comment docs.

aktech · 2017-05-28T09:32:48Z

@ncoghlan I have made the changes, please have a look.

ncoghlan · 2017-05-29T01:02:47Z

Merged, thanks!

miss-islington · 2017-09-07T00:13:04Z

🐍🍒⛏🤖 Thanks @aktech for the PR, and @ncoghlan for merging it 🌮🎉.I'm working now to backport this PR to: 3.6.

miss-islington · 2017-09-07T00:13:06Z

Sorry, @aktech and @ncoghlan, I could not cleanly backport this to 3.6 due to a conflict.
Please backport using cherry_picker on command line.

bedevere-bot · 2017-09-11T05:54:02Z

GH-3491 is a backport of this pull request to the 3.6 branch.

…tin (pythonGH-166). (cherry picked from commit 2e6bb44)

…tin (GH-166). (#3491) (cherry picked from commit 2e6bb44)

…tin (GH-166). (#3492) (cherry picked from commit 2e6bb44)

The C-API functions PyEval_EvalFrameEx() and PyEval_EvalFrame() were broken, because Stackless does not use them and didn't test them. This commit adds test code and makes the functions compatible with C-Python. It is now save to call them from extension modules, i.e. modules created by Cython.

Support using PyEval_EvalFrameEx() without a main tasklet. And fix a potential reference counting problem.

The C-API functions PyEval_EvalFrameEx() and PyEval_EvalFrame() were broken, because Stackless does not use them and didn't test them. This commit adds test code and makes the functions compatible with C-Python. It is now save to call them from extension modules, i.e. modules created by Cython. (cherry picked from commit d377c06)

Support using PyEval_EvalFrameEx() without a main tasklet. And fix a potential reference counting problem. (cherry picked from commit 187184b)

The C-API functions PyEval_EvalFrameEx() and PyEval_EvalFrame() were broken, because Stackless does not use them and didn't test them. This commit adds test code and makes the functions compatible with C-Python. It is now save to call them from extension modules, i.e. modules created by Cython. (cherry picked from commit d377c06)

Support using PyEval_EvalFrameEx() without a main tasklet. And fix a potential reference counting problem. (cherry picked from commit 187184b)

the-knights-who-say-ni added the CLA not signed label Feb 19, 2017

serhiy-storchaka added the type-feature A feature request or enhancement label Feb 19, 2017

serhiy-storchaka requested changes Feb 19, 2017

View reviewed changes

aktech force-pushed the format-doc branch 2 times, most recently from 17428a5 to 2a96971 Compare February 19, 2017 10:03

Mariatta removed the CLA not signed label Feb 21, 2017

the-knights-who-say-ni added the CLA signed label Feb 21, 2017

aktech force-pushed the format-doc branch from 2a96971 to cfd5d43 Compare March 28, 2017 17:09

serhiy-storchaka requested review from bitdancer, ericvsmith and terryjreedy March 28, 2017 17:21

serhiy-storchaka approved these changes Mar 28, 2017

View reviewed changes

terryjreedy requested changes Mar 28, 2017

View reviewed changes

ncoghlan requested changes May 27, 2017

View reviewed changes

ncoghlan added the sprint label May 28, 2017

aktech force-pushed the format-doc branch from 1824378 to a11bc6d Compare May 28, 2017 09:10

Add reference to help('FORMATTING') in format() builtin

f2ccf62

aktech force-pushed the format-doc branch from 005ab67 to f2ccf62 Compare May 28, 2017 09:20

ncoghlan added the needs backport to 3.6 label May 29, 2017

ncoghlan approved these changes May 29, 2017

View reviewed changes

ncoghlan merged commit 2e6bb44 into python:master May 29, 2017

Mariatta added needs backport to 3.6 and removed needs backport to 3.6 labels Sep 7, 2017

bedevere-bot removed the needs backport to 3.6 label Sep 11, 2017

serhiy-storchaka pushed a commit to serhiy-storchaka/cpython that referenced this pull request Sep 11, 2017

[3.6] bpo-29526: Add reference to help('FORMATTING') in format() buil…

6e3aa8a

…tin (pythonGH-166). (cherry picked from commit 2e6bb44)

serhiy-storchaka pushed a commit to serhiy-storchaka/cpython that referenced this pull request Sep 11, 2017

[2.7] bpo-29526: Add reference to help('FORMATTING') in format() buil…

d004997

…tin (pythonGH-166). (cherry picked from commit 2e6bb44)

serhiy-storchaka added a commit that referenced this pull request Sep 11, 2017

[3.6] bpo-29526: Add reference to help('FORMATTING') in format() buil…

c67838d

…tin (GH-166). (#3491) (cherry picked from commit 2e6bb44)

serhiy-storchaka added a commit that referenced this pull request Sep 11, 2017

[2.7] bpo-29526: Add reference to help('FORMATTING') in format() buil…

6ed7aff

…tin (GH-166). (#3492) (cherry picked from commit 2e6bb44)

akruis pushed a commit to akruis/cpython that referenced this pull request Aug 16, 2018

Stackless issue python#166: Fix PyEval_EvalFrameEx()

187184b

Support using PyEval_EvalFrameEx() without a main tasklet. And fix a potential reference counting problem.

akruis pushed a commit to akruis/cpython that referenced this pull request Aug 16, 2018

Stackless issue python#166: Fix PyEval_EvalFrameEx()

4aefdd0

Support using PyEval_EvalFrameEx() without a main tasklet. And fix a potential reference counting problem. (cherry picked from commit 187184b)

akruis pushed a commit to akruis/cpython that referenced this pull request Sep 11, 2018

Stackless issue python#166: Fix PyEval_EvalFrameEx()

070e7f0

Support using PyEval_EvalFrameEx() without a main tasklet. And fix a potential reference counting problem. (cherry picked from commit 187184b)

aktech deleted the format-doc branch July 18, 2020 00:42

mikez mentioned this pull request Sep 3, 2022

Change docstring of format() built-in #96526

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-29526 Add reference to help('FORMATTING') in format() builtin #166

bpo-29526 Add reference to help('FORMATTING') in format() builtin #166

aktech commented Feb 19, 2017 •

edited

Loading

the-knights-who-say-ni commented Feb 19, 2017

serhiy-storchaka Feb 19, 2017

aktech Feb 19, 2017

aktech commented Mar 28, 2017

terryjreedy Mar 28, 2017

ncoghlan May 27, 2017

ncoghlan left a comment

ncoghlan May 27, 2017

ncoghlan commented May 28, 2017

codecov bot commented May 28, 2017

aktech commented May 28, 2017

ncoghlan commented May 29, 2017

miss-islington commented Sep 7, 2017

miss-islington commented Sep 7, 2017

bedevere-bot commented Sep 11, 2017

bpo-29526 Add reference to help('FORMATTING') in format() builtin #166

bpo-29526 Add reference to help('FORMATTING') in format() builtin #166

Conversation

aktech commented Feb 19, 2017 • edited Loading

the-knights-who-say-ni commented Feb 19, 2017

serhiy-storchaka Feb 19, 2017

Choose a reason for hiding this comment

aktech Feb 19, 2017

Choose a reason for hiding this comment

aktech commented Mar 28, 2017

terryjreedy Mar 28, 2017

Choose a reason for hiding this comment

ncoghlan May 27, 2017

Choose a reason for hiding this comment

ncoghlan left a comment

Choose a reason for hiding this comment

ncoghlan May 27, 2017

Choose a reason for hiding this comment

ncoghlan commented May 28, 2017

codecov bot commented May 28, 2017

Codecov Report

aktech commented May 28, 2017

ncoghlan commented May 29, 2017

miss-islington commented Sep 7, 2017

miss-islington commented Sep 7, 2017

bedevere-bot commented Sep 11, 2017

aktech commented Feb 19, 2017 •

edited

Loading