[issue32784] Wrong argument name for csv.DictReader in documentation

[Mariatta Wijaya]

Mariatta Wijaya  added the comment:

3.5 is for security fixes only now. We don't do documentation or regular bug 
fixes there anymore.

--
versions:  -Python 3.5

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[cowlinator]

cowlinator  added the comment:

Hi, thanks for the quick action on this!

The documentation is still wrong for 3.5 .  I had selected 3.5 for the affected 
versions, but I guess it got removed?

--
versions: +Python 3.5

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[Mariatta Wijaya]

Mariatta Wijaya  added the comment:

Thanks everyone!

--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[Mariatta Wijaya]

Mariatta Wijaya  added the comment:


New changeset 672fd7d8162f76aff8423fa5c7bfd2b1e91faf57 by Mariatta (Stéphane 
Wirtel) in branch '2.7':
bpo-32784: Wrong argument name for csv.DictReader in documentation (GH-5575)
https://github.com/python/cpython/commit/672fd7d8162f76aff8423fa5c7bfd2b1e91faf57


--
nosy: +Mariatta

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[Stéphane Wirtel]

Stéphane Wirtel  added the comment:

Hi David, 

At the final, I didn't propose my PR with the renaming. because PyPy and 
CPython use f as the first parameter of these classes.

If @Serhiy does the review of my PR, we can close this issue.

--

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[R. David Murray]

R. David Murray  added the comment:

Stéphane: I don't understand your question about changing the name of the 
parameter.  As far as I can see the only thing to do here is backport the doc 
fix to 2.7.

--

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[Stéphane Wirtel]

Stéphane Wirtel  added the comment:

Hi @Serhiy

I try to use the cherry-picking method for the patch from 3.6 but without 
success, I preferred to reuse my initial commit and remove the News.d entry.

--

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:

See issue16026 for the fix in 3.x.

--
nosy: +serhiy.storchaka

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[Stéphane Wirtel]

Stéphane Wirtel  added the comment:

I just fixed the documentation, but I think we should change the name of the 
first parameter in master for 3.8. Maybe for 3.7, because we have to fix the 
docs. 

@david, what is your opinion?

I am going to propose a PR for the naming of the first argument

--
keywords: +needs review -patch
nosy: +matrixise

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[Stéphane Wirtel]

Change by Stéphane Wirtel :


--
keywords: +patch
pull_requests: +5393
stage:  -> patch review

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[Josh Rosenberg]

Josh Rosenberg  added the comment:

Side-note: You say "how could i have known it was named 'f'?"

>>> help(csv.DictReader)
class DictReader
 |  Methods defined here:
 |
 |  __init__(self, f, fieldnames=None, restkey=None, restval=None, 
dialect='excel', *args, **kwds)
... rest of class help ...

Not saying the docs shouldn't be fixed, but the name is correctly given in the 
__init__ prototype (being implemented in Python, the names are always available 
to help() introspection, barring really specific cases of manual parsing of 
**kwargs). Just a general tip for the future.

--
nosy: +josh.r

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[R. David Murray]

R. David Murray  added the comment:

In the python3 docs it is given as 'f'.  In the python2 docs, it is not.  I 
suppose a doc backport was missed.

--
nosy: +r.david.murray
versions:  -Python 3.5

___
Python tracker 

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

[issue32784] Wrong argument name for csv.DictReader in documentation

[cowlinator]

New submission from cowlinator :

The documentation for the csv.DictReader constructor (and presumably 
csv.DictWriter also) has the wrong name written for the first argument.  This 
prevents the argument from being called by name.

>>> file = open("file.txt", 'a')
>>> csv.DictReader(csvfile=file)
Traceback (most recent call last):
  File "", line 1, in 
TypeError: __init__() takes at least 2 arguments (1 given)
>>> csv.DictReader(f=file)

>>> # how could i have known it was named 'f'?

Please change the documentation.

--
messages: 311759
nosy: cowlinator
priority: normal
severity: normal
status: open
title: Wrong argument name for csv.DictReader in documentation
versions: Python 2.7, Python 3.5

___
Python tracker 

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