[issue9739] Output of help(...) is wider than 80 characters

[Mark Lawrence]

Change by Mark Lawrence :


--
nosy:  -BreamoreBoy

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9739] Output of help(...) is wider than 80 characters

[Terry J. Reedy]

Terry J. Reedy added the comment:

Perhaps after the Google Summer of Code project is done (mid-August).

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9739] Output of help(...) is wider than 80 characters

[Mark Lawrence]

Mark Lawrence added the comment:

@Terry is this something you could take on?

--
nosy: +BreamoreBoy
versions: +Python 3.5 -Python 3.2

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9739] Output of help(...) is wider than 80 characters

[Case Van Horsen]

Case Van Horsen  added the comment:

I edited the doc string for math.modf since an indent of 8 spaces is used for 
the doc string with help(math). An indent of 4 spaces is used with 
help(math.modf).

I've attached a new patch for just the math module that includes the return 
type as part of signature line, corrects the width issues, and uses a 
consistent format for defining the doc strings.

--
Added file: http://bugs.python.org/file18761/math_docstring.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9739] Output of help(...) is wider than 80 characters

[Terry J. Reedy]

Terry J. Reedy  added the comment:

Although this is not a problem in IDLE where the window can easily be expanded 
beyond 80 chars, I am in favor of the idea for other uses. The command line 
interpreter on Windows defaults to 80 chars and is not so easy to change, and 
one must be admin to make the change 'permanent' (until the next install 
reverts the change). In particular, the 82 char line for math.trun results in 
'd.' of 'method.' wrapped to a line by itself with no indent. Pretty ugly.

However, I am puzzled why you edited the 74 char line for math.modf, which 
displays as 78 chars with a 4 char indent. This
'''\
Return the fractional and integer parts of x.  Both results carry the 
sign'''
displays fine on one line as is. The tracker, unfortunately, displays
123456789012345678901234567890123456789012345678901234567890123456789012 only 
72 chars.
of x and are floats.

I agree that
trunc(x:Real) -> Integral
is more helpful (and therefore better) than
modf(x)

For something like
-"T.index(value, [start, [stop]]) -> integer -- return first index of value.\n"

I personally think '->' and 'return are redundant, so I would argue that this 
could be shortened to
-"T.index(value, [start, [stop]]) -> integer (first index of value).\n"
instead of by wrapping.

Since I am not yet in a position to apply patches, I am not (yet) in a position 
to tell you whether or how to produce more patches.

--
nosy: +terry.reedy
stage:  -> patch review
versions: +Python 3.2

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9739] Output of help(...) is wider than 80 characters

[Case Van Horsen]

Case Van Horsen  added the comment:

According to PEP 7, the first line of the doc string should contain the 
signature of the function, then there should be a blank line, and then the rest 
of the doc string. There may be tools that extract the signature line. The 
patch just decreases the line length of the remaining lines of the doc string 
so they don't wrap when displayed on an 80 character wide terminal window.

For an example, look at the text for modf(...) in help(math).

I just noticed that the math module uses "modf(x)" for the signature line but 
PEP 7 recommends including the return type, say "modf(x) -> (frac, int)".

The simplest change would be to fix the wrapping issue and leave the signature 
line alone. It would be more effort to make all the doc strings PEP 7 compliant 
by standardizing the signature line to include the return type.

I'm willing to work through the standard library and create patches for either 
option.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9739] Output of help(...) is wider than 80 characters

[Giampaolo Rodola']

Changes by Giampaolo Rodola' :


--
nosy: +giampaolo.rodola

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9739] Output of help(...) is wider than 80 characters

[Amaury Forgeot d'Arc]

Amaury Forgeot d'Arc  added the comment:

Aren't there tools that extract only the first line of help?

--
assignee:  -> d...@python
components: +Documentation -Extension Modules
nosy: +amaury.forgeotdarc, d...@python

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue9739] Output of help(...) is wider than 80 characters

[Case Van Horsen]

New submission from Case Van Horsen :

In several modules, the output of help(some_module) is wider than 80 
characters. This results in extra line wrapping and incorrect formatting of the 
help text.

I've attached a single patch (doc_width1.diff) that corrects the issue for 
math, cmath, tuple, datetime, and time modules. I can continue to create 
patches for a few modules at a time, or I can create patches for individual 
modules.

I'm not changing any text, only adding \n as needed.

--
components: Extension Modules
files: doc_width1.diff
keywords: patch
messages: 115359
nosy: casevh
priority: normal
severity: normal
status: open
title: Output of help(...) is wider than 80 characters
type: behavior
Added file: http://bugs.python.org/file18707/doc_width1.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com