Skip to content

Conversation

@bodhisilberling
Copy link
Contributor

…colon

@picnixz
Copy link
Member

picnixz commented Jan 24, 2026

Can you check if there are other typos in the docstrings of this module as well as checking the online RST docs to see if the rendered content has such typos?

@picnixz picnixz changed the title Fix docstring formatting: remove double space and extra space before … Fix typo in urllib.parse.urlsplit docstring Jan 24, 2026
@picnixz picnixz changed the title Fix typo in urllib.parse.urlsplit docstring Fix typo in urllib.parse docstring Jan 24, 2026
@picnixz picnixz changed the title Fix typo in urllib.parse docstring Fix typos in urllib.parse docstring Jan 24, 2026
@picnixz
Copy link
Member

picnixz commented Jan 26, 2026

Actually, by looking at the file, I see that it's not the only place that the references are wrongly... produced. So... sorry but I think the change would still too big (we sometimes have "L. Masinter", sometimes "L.Masinter" and sometimes "L Masinter"). So... I would either:

  • Properly format the references in a canonical format (MLA, APA, ePrint, whichsoever is the best here).
  • Do nothing.

I'm now more inclined to actually do nothing even if the docstring is user-facing.

cc @hugovk

@hugovk
Copy link
Member

hugovk commented Jan 26, 2026

I don't mind, but the relevant RFCs all say L. Masinter at the top.

@picnixz
Copy link
Member

picnixz commented Jan 26, 2026

Ok, since it's about a list of references, let's properly list them. If it were some other stuff in the prose, maybe it would have been fine, but let's properly format the list of references (not just L. Masinter).

@picnixz picnixz changed the title Fix typos in urllib.parse docstring Correctly format list of references in urllib.parse docstring Jan 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants