[New-bugs-announce] [issue15350] {urllib, urllib.parse}.urlencode.__doc__ is unclear

[samwyse]

New submission from samwyse <samwyse at gmail.com>:

The doc string for url encode states:

    The query arg may be either a string or a bytes type. When query arg is a
    string, the safe, encoding and error parameters are sent to the quote_via
    function for encoding

IMHO, this implies that the argument can be a string.  Note that the preceding paragraphs starts out with "If the query arg is a sequence of two-element tuples". I think that it should read:

    The components of the query arg may be either a string or a bytes
    type. When query arg is a string, the safe, encoding and error
    parameters are sent to the quote_via function for encoding.

----------
components: Library (Lib)
messages: 165440
nosy: samwyse
priority: normal
severity: normal
status: open
title: {urllib,urllib.parse}.urlencode.__doc__ is unclear
type: behavior
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15350>
_______________________________________