Skip to content

bpo-35116: Adding Doc/library entries for cgi.FieldStorage max_num_fields#10247

Merged
vstinner merged 3 commits into
python:masterfrom
matthewbelisle-wf:cgi-max-num-fields-docs
Oct 30, 2018
Merged

bpo-35116: Adding Doc/library entries for cgi.FieldStorage max_num_fields#10247
vstinner merged 3 commits into
python:masterfrom
matthewbelisle-wf:cgi-max-num-fields-docs

Conversation

@matthewbelisle-wf

@matthewbelisle-wf matthewbelisle-wf commented Oct 30, 2018

Copy link
Copy Markdown
Contributor

@matthewbelisle-wf

Copy link
Copy Markdown
Contributor Author

For your review @vstinner from your comment in #9969 (comment).

Comment thread Doc/library/urllib.parse.rst Outdated
Add *encoding* and *errors* parameters.

.. versionchanged:: 3.8
Added *max_num_fields* param.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please replace "param" with "parameter.

Comment thread Doc/library/urllib.parse.rst Outdated
Add *encoding* and *errors* parameters.

.. versionchanged:: 3.8
Added *max_num_fields* param.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.

@matthewbelisle-wf

Copy link
Copy Markdown
Contributor Author

Ditto, fixed in 1c3f2f0 @vstinner

Comment thread Doc/library/urllib.parse.rst Outdated
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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 :-)

Comment thread Doc/library/urllib.parse.rst Outdated

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*.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Default is None." IMHO it's redundant with the function prototype and can be removed.

Comment thread Doc/library/urllib.parse.rst Outdated

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*.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.

@matthewbelisle-wf

Copy link
Copy Markdown
Contributor Author

Sure thing @vstinner fixed in 51d6fb3.

@vstinner vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@vstinner

Copy link
Copy Markdown
Member

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

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants