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
Make int() and str() docstrings correct #58988
Comments
int.__doc__ starts "int(x[, base]) -> integer". That is not exactly correct as x is not required and base is only allowed if x is a string. The 3.3 manual fixes both problems with "int([number | string[, base]])" I actually think the rest of the docstring might be replaced with the more accurate and informative manual entry. It might be condensed, but I am not sure what might be omitted. |
The 3.3 version has the virtue of being accurate and the vice of being confusing. In a way, it has made the docs worse for the average user of common cases. Is there a way to stack the alternative signatures rather than mush the various used into a single pile of mush?
|
.. function:: int(n=0) should do the trick. |
+1! This notation helps clearing up how int, str and other constructors work. |
Here's a patch for the signature. |
The large issue is documenting complex signatures that do not really fit in any of the standard one-line patterns. I was initially puzzled by Raymond describing the 3.3 line as 'confusing', but putting on 'newbie glasses' I see now that correctly parsing However, this issue is about the docstring. Leave it incorrect? Change it to the hard-to-parse one liner? Change it to a two-line signature also? I noticed this issue while working on IDLE tooltips, using int as a test case. They currently use only the first line of the docstring, but I have decided that they should get more when needed for C functions. (For Python functions, tooltips use inspect for the actual signature and the first docstring line only for a description.) The first line of the str docstring is also incorrect in that the optional parameters are only valid for first arguments that are strings. While we are at it, how about The bytes and bytearrays docstrings have 5 signature lines!. (The manual gives just one which does not quite cover all cases.) So (a) there is precedent for multiple signatures in docstrings and (b) tooltips already need to grab multiple signature lines. So I think int and str (and maybe range) should use a couple of clear lines. If the new inspect.signature function were to give signatures for C functions, there would be no problem for tooltips, but it does not. (Can signature objects even handle multiple (or type-dependent) signatures?) |
The issues about "weird" signatures are being discussed on bpo-15831.
For the docstring it's ok to use the double signature too. The description, while not too comprehensive, is understandable. |
First argument is named "x". >>> int(number=42)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'number' is an invalid keyword argument for this function
>>> int(x=42)
42 + int(string, base=10) Here can be not only string, but bytes or bytearray. >>> int('42', 6)
26
>>> int(b'42', 6)
26
>>> int(bytearray(b'42'), 6)
26 |
Sometimes the doc uses "better" names to improve clarity when the argument is not supposed to be called as keyword arg.
The same applies here. "string" is also used in the error message (int() can't convert non-string with explicit base). If bytes/bytearrays are accepted too it could be mentioned later in the prose. Otherwise we could use x for both, but the distinction would be less clear. |
It may be worth rewrite int() and str() so that the first argument was positional-only argument? |
That would be backward incompatible, and there might be some valid (corner) cases to pass it as a keyword. Since people are usually not supposed to use it as a keyword arg, it doesn't matter much if the name is different if that makes the docs more understandable. If someone tries to do int(number=10) and gets an error it would likely switch to the simpler int(10). If he really needs keyword args he can always check the code. That said, I don't have a strong opinion about this, so if people think that x should be used, it's fine with me. |
To make it easier to make progress on this docstring issue, I created bpo-16036 to focus on int()'s reST documentation. (I have a comment on that aspect.) This will allow the current issue to focus on the docstring aspect. |
The change for bpo-15831 contains a number of places where a single signature line was converted to multiple -- but in the docs and not the docstrings. Those instances can also be examined for this issue. The signature line for str() was not updated in that patch, however. |
For the record, this is also true of 2.7: http://hg.python.org/cpython/file/15fd0b4496e0/Objects/bytearrayobject.c#l2870 |
Attaching proposed patch. This updates the docstrings for int() and str(), as well as for range() and slice() in a similar way. It also makes the documentation for str() closer to that of the docstring. The documentation for int(), range(), and slice() has already been updated along the lines of this patch. |
Any comments on the latest patch, in particular on the int() docstring? Especially you, Terry, as you created the issue? |
LGTM |
I checked pretty carefully and it looks good to me. |
New changeset e4598364ea29 by Chris Jerdonek in branch '3.2': New changeset 365da47a6dc1 by Chris Jerdonek in branch '3.3': New changeset 3773c98d9da8 by Chris Jerdonek in branch 'default': |
Leaving open to backport applicable portions to 2.7. I should get to that later today. |
New changeset 3b484f53f91b by Chris Jerdonek in branch '2.7': |
New changeset 181c170c6270 by Chris Jerdonek in branch '3.2': |
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:
bugs.python.org fields:
The text was updated successfully, but these errors were encountered: