bpo-38495: Updated functions.rst: Clearer *sep* and *end* defaults explanation #17062
bpo-38495: Updated functions.rst: Clearer *sep* and *end* defaults explanation #17062Seluj78 wants to merge 2 commits into
Conversation
|
cc @vstinner |
Seluj78
changed the title
|
@bedevere-bot updated title for issue number |
Removed trailing whitespace
|
ping @JulienPalard for review |
|
@Seluj78, I've seen you ping/CC specific core devs on several recent PRs. Please avoid doing so unless they've specifically asked you to. Core devs can make sure they're notified on changes to specific files. If they haven't done so, they probably don't want to be actively pinged on every such change. |
|
That being said, @Seluj78, your enthusiasm and efforts to help improve Python are greatly appreciated! Please be patient with regard to our limited ability to address the many issues and PRs. |
For Victor Stinner and Julien Palard, I know them very well (not an excuse, just a note) and they've told me that I could 😄 |
|
Ah, @Seluj78, that's fine then 👍 |
I confirm. But I only plan to quickly approve trivial doc fixes like typos, and let others review more complex ones :-) FYI Jules and Julien are actively working together on the french documentation translation, that's how they spot so many tiny doc issues ;-) |
| Print *objects* to the text stream *file* (the standard output by default), | ||
| separated by *sep* (a space by default) and followed by *end* | ||
| (a newline by default). | ||
| *sep*, *end*, *file* and *flush*, if present, must be given as keyword arguments. |
There was a problem hiding this comment.
As a Python expert, I dislike such redundant documentation: the default value is already documented on the " .. function:: print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False)" line. Moreover, this line ("*objects, " part) also explains that these parameters are keyword-only (cannot be passed as positional arguments).
There was a problem hiding this comment.
I understand where you're coming from, I personally feel it's clearer that way
Also I followed your advice when you told me to look into bugs.python.org for doc bugs and I did, it's on you 😉
I mean that it's just my opinion. I have no idea if developers learning Python would prefer to have such "redundant" documentaiton. But it may be more expensive to maintain if we change the default values. |
|
I don't think this PR should be accepted. The ticket on the bug tracker seemed more for the idea that the OP couldn't see the space in -1 from me. |
7 participants
https://bugs.python.org/issue38495