[issue37970] urllib.parse docstrings incomplete

Ido Michael added the comment: Created PR, most of the documentation besides the func signature looked alright: GH-18631 -- ___ Python tracker ___ ___

[issue37970] urllib.parse docstrings incomplete

Change by Ido Michael : -- pull_requests: +17997 pull_request: https://github.com/python/cpython/pull/18631 ___ Python tracker ___ _

[issue37970] urllib.parse docstrings incomplete

Tal Einat added the comment: Indeed. -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.

[issue37970] urllib.parse docstrings incomplete

Ido Michael added the comment: Tal, I can also fix that so we can close this issue. Are you talking about the Doc/library/urllib.parse.rst file? -- ___ Python tracker ___

[issue37970] urllib.parse docstrings incomplete

Tal Einat added the comment: Ido Michael's PR GH-16458, which I've just merged, addresses the issues brought up here regarding the doc-strings. >From the discussion it seems that the documentation of these functions should >be updated as well. I'll leave this issue open until that's done as

[issue37970] urllib.parse docstrings incomplete

Tal Einat added the comment: New changeset c33bdbb20cf55b3a2aa7a91bd3d91fcb59796fad by idomic in branch 'master': bpo-37970: update and improve urlparse and urlsplit doc-strings (GH-16458) https://github.com/python/cpython/commit/c33bdbb20cf55b3a2aa7a91bd3d91fcb59796fad -- nosy: +ta

[issue37970] urllib.parse docstrings incomplete

Ido Michael added the comment: Hey Senthil, Yes the PEP guides was fixed a while ago, also the new comment of adding the same change for the second function were taken care of. -- ___ Python tracker ___

[issue37970] urllib.parse docstrings incomplete

Senthil Kumaran added the comment: Hi Ido, there was a change requested by a core-dev, Zachary , on your PR. > Please have a look at PEP 257 for docstring formatting guidelines. https://github.com/python/cpython/pull/16458/files#r353422155 Please let us know if that is addressed. -

[issue37970] urllib.parse docstrings incomplete

Ido Michael added the comment: Any update on this? Adding @Tal Einat on the PR -- ___ Python tracker ___ ___ Python-bugs-list maili

[issue37970] urllib.parse docstrings incomplete

Ido Michael added the comment: Committed a PR: GH-16458 I've read all of the thread and changed the docstring to the latest suggestion by @zach.ware Ido -- nosy: +Ido Michael ___ Python tracker __

[issue37970] urllib.parse docstrings incomplete

Change by Ido Michael : -- keywords: +patch pull_requests: +16039 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/16458 ___ Python tracker _

[issue37970] urllib.parse docstrings incomplete

sushma added the comment: got it - thanks for the detailed explanation! I'll go ahead and create a PR soon -- ___ Python tracker ___ __

[issue37970] urllib.parse docstrings incomplete

Zachary Ware added the comment: I see. I don't think we need to describe each returned component in the docstring; they're some combination of self-explanatory, described in the reference docs, or just industry-standard terms that are easily defined from other sources. I'm not suggesting t

[issue37970] urllib.parse docstrings incomplete

sushma added the comment: I guess what I'm wondering is this: urlsplit(url, scheme='', allow_fragments=True) Parse a URL into 5 components: :///?# Return a 5-tuple: (scheme, netloc, path, query, fragment). Note that we don't break the components up in smaller bits (e.g. ne

[issue37970] urllib.parse docstrings incomplete

Zachary Ware added the comment: >I don't understand why we'd have scheme and netloc, but nothing for path and >query. I'm not sure what you mean here; can you please clarify? > What are you suggesting we add for scheme/allow_fragements? Just a brief description of what effect the arguments

[issue37970] urllib.parse docstrings incomplete

sushma added the comment: hello! I can see that we might want to add documentation for splitting netloc, but I don't understand why we'd have scheme and netloc, but nothing for path and query. What are you suggesting we add for scheme/allow_fragements? Thanks! -- nosy: +syadlapall

[issue37970] urllib.parse docstrings incomplete

Joannah Nanjekye added the comment: > Also, the note about not splitting netloc is misleading; the components > of > netloc (username, password, hostname, and port) are available as >extra > attributes of the returned SplitResult. Also, the docs in urllib.parse.rst should also be updated to

[issue37970] urllib.parse docstrings incomplete

New submission from Zachary Ware : For example, urlsplit: >>> from urllib.parse import urlsplit >>> help(urlsplit) Help on function urlsplit in module urllib.parse: urlsplit(url, scheme='', allow_fragments=True) Parse a URL into 5 components: :///?# Return a 5-tuple: (scheme, netlo