bpo-35116: Adding Doc/library entries for cgi.FieldStorage max_num_fields #10247
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matthewbelisle-wf
force-pushed
the
cgi-max-num-fields-docs
branch
from
a4d2363 to
4823ae0
Compare
matthewbelisle-wf
force-pushed
the
cgi-max-num-fields-docs
branch
from
4823ae0 to
98ace4b
Compare
|
For your review @vstinner from your comment in #9969 (comment). |
vstinner
reviewed
Oct 30, 2018
Doc/library/urllib.parse.rst
Outdated
| @@ -166,8 +170,11 @@ or on combining URL components into a URL string. | |||
| .. versionchanged:: 3.2 | |||
| Add *encoding* and *errors* parameters. | |||
|
|
|||
| .. versionchanged:: 3.8 | |||
| Added *max_num_fields* param. | |||
There was a problem hiding this comment.
Please replace "param" with "parameter.
vstinner
reviewed
Oct 30, 2018
Doc/library/urllib.parse.rst
Outdated
| Use the :func:`urllib.parse.urlencode` function to convert such lists of pairs into | ||
| query strings. | ||
|
|
||
| .. versionchanged:: 3.2 | ||
| Add *encoding* and *errors* parameters. | ||
|
|
||
| .. versionchanged:: 3.8 | ||
| Added *max_num_fields* param. |
vstinner
reviewed
Oct 30, 2018
Doc/library/urllib.parse.rst
Outdated
| @@ -158,6 +158,10 @@ or on combining URL components into a URL string. | |||
| percent-encoded sequences into Unicode characters, as accepted by the | |||
| :meth:`bytes.decode` method. | |||
|
|
|||
| The optional argument *max_num_fields* is a flag for the maximum number of | |||
There was a problem hiding this comment.
I would just say "The optional argument max_num_fields is the maximum number of ..."
Note: wait until this PR is merged before updating the 3 other PRs :-)
Doc/library/urllib.parse.rst
Outdated
| @@ -158,6 +158,10 @@ or on combining URL components into a URL string. | |||
| percent-encoded sequences into Unicode characters, as accepted by the | |||
| :meth:`bytes.decode` method. | |||
|
|
|||
| The optional argument *max_num_fields* is a flag for the maximum number of | |||
| fields to read. If set, then throws a :exc:`ValueError` if there are more | |||
| than *max_num_fields* fields read. Default is *None*. | |||
There was a problem hiding this comment.
"Default is None." IMHO it's redundant with the function prototype and can be removed.
Doc/library/urllib.parse.rst
Outdated
| @@ -187,12 +194,19 @@ or on combining URL components into a URL string. | |||
| percent-encoded sequences into Unicode characters, as accepted by the | |||
| :meth:`bytes.decode` method. | |||
|
|
|||
| The optional argument *max_num_fields* is a flag for the maximum number of | |||
| fields to read. If set, then throws a :exc:`ValueError` if there are more | |||
| than *max_num_fields* fields read. Default is *None*. | |||
|
You can now update the 3 other PRs :-) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://bugs.python.org/issue35116