[issue25822] Add docstrings to fields of urllib.parse results

[Swati Jaiswal]

Swati Jaiswal added the comment:

Thank you Senthil for the improvements, I'll try to make it better next time :)

--

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Senthil Kumaran]

Senthil Kumaran added the comment:

Thank you, Swati. 

I reviewed and committed your patch. I had to make some minor formatting 
changes while keeping an eye for the maintainability of the module and doc 
strings.

* Moved all the doc strings up to a single place just below the namespaces are 
declared.
* Followed pep-0257 conventions for doc strings.
* Tried DRY for parse result's sub-components.

Thanks for addressing the review comments from other developers.

--
resolution:  -> fixed
status: open -> closed

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Roundup Robot]

Roundup Robot added the comment:

New changeset 7bfcb8b75ad9 by Senthil Kumaran in branch 'default':
Issue #25822: Add docstrings to the fields of urllib.parse results.
https://hg.python.org/cpython/rev/7bfcb8b75ad9

--
nosy: +python-dev

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Senthil Kumaran]

Changes by Senthil Kumaran :


--
assignee:  -> orsenthil

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Swati Jaiswal]

Changes by Swati Jaiswal :


Added file: http://bugs.python.org/file41456/iss_25822_4.patch

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Could you please also add docstrings for _DefragResultBase?

I agree that there is no need to write tests.

--

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Raymond Hettinger]

Raymond Hettinger added the comment:

I wouldn't normally write a test for a docstring patch.

--

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Swati Jaiswal]

Changes by Swati Jaiswal :


Added file: http://bugs.python.org/file41300/iss_25822_3.patch

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Martin Panter]

Martin Panter added the comment:

[padding]
I left some comments.

I wonder if the doc strings are too specific when they mention “request”, 
“file”, “download”, “page”, etc. Maybe these could just be examples of what the 
fields are used for (e.g. “The hierarchical path, such as the path to a file to 
download”). Or maybe they could be changed to general terms, but this may be 
hard.

Also, some of them seem redundant. Does it really add anything to say the 
“query” field is “the query parameter”?

--

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Swati Jaiswal]

Changes by Swati Jaiswal :


Added file: http://bugs.python.org/file41290/iss_25822_2.patch

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Berker Peksag]

Berker Peksag added the comment:

Thanks, Swati. I left a few comments on Rietveld: 
http://bugs.python.org/review/25822/

A test wouldn't hurt, but you can wait for further review comments to avoid 
updating tests each time you get a comment.

--
nosy: +berker.peksag

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
nosy: +martin.panter, orsenthil
stage: needs patch -> patch review

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Swati Jaiswal]

Swati Jaiswal added the comment:

Here is the patch, please review it. Do I need to write any test?

--
keywords: +patch
Added file: http://bugs.python.org/file41283/iss_25822.patch

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Swati Jaiswal]

Swati Jaiswal added the comment:

I can help with this. Should I propose the changes I am going to make before 
making them or just create the patch?

--
nosy: +curioswati

___
Python tracker 

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

[issue25822] Add docstrings to fields of urllib.parse results

[Serhiy Storchaka]

New submission from Serhiy Storchaka:

Results of urlsplit() and urlparse() functions in the urllib.parse module are 
named tuple with a number of fields. Since property docstrings are writable now 
(issue24064), we can provide docstrings for all these fields. See also 
issue24878.

--
components: Library (Lib)
messages: 256105
nosy: rhettinger, serhiy.storchaka
priority: normal
severity: normal
stage: needs patch
status: open
title: Add docstrings to fields of urllib.parse results
type: enhancement
versions: Python 3.6

___
Python tracker 

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