Skip to content

Changes to the documentation of normpath#14004

Merged
matrixise merged 1 commit into
python:masterfrom
kianasun:fix-normpath-doc
Sep 13, 2019
Merged

Changes to the documentation of normpath#14004
matrixise merged 1 commit into
python:masterfrom
kianasun:fix-normpath-doc

Conversation

@kianasun
Copy link
Copy Markdown
Contributor

@kianasun kianasun commented Jun 12, 2019

No description provided.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jun 12, 2019
@asvetlov
Copy link
Copy Markdown
Contributor

asvetlov commented Jun 12, 2019

We should add Raise a TypeError if the type of path is not str or bytes... to every module's function for consistency.
Not sure if this improves readability.

@kianasun
Copy link
Copy Markdown
Contributor Author

kianasun commented Jun 12, 2019

Hi @asvetlov , thanks for your reply. Some other functions, such as normcase have this sentence in the document. I think we should add it to improve consistency and readability.

@willingc
Copy link
Copy Markdown
Contributor

willingc commented Jun 15, 2019

Hi @kianasun. I agree with @asvetlov. If you have the time, please update the PR as recommended by @asvetlov. Thanks :D

@kianasun
Copy link
Copy Markdown
Contributor Author

kianasun commented Jun 17, 2019

@willingc I removed the sentence Raise a TypeError if the type of path... in normcase to be consistent.

@kianasun
Copy link
Copy Markdown
Contributor Author

kianasun commented Jun 25, 2019

Hi @willingc, is there anything else that I need to change? Thanks :)

@matrixise matrixise merged commit 53f78ec into python:master Sep 13, 2019
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Sep 13, 2019

Thanks @kianasun for the PR, and @matrixise for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Sep 13, 2019

GH-16096 is a backport of this pull request to the 3.8 branch.

@matrixise
Copy link
Copy Markdown
Member

matrixise commented Sep 13, 2019

Thank you for your pull request, I have started the merge process. Have a nice day.

miss-islington added a commit that referenced this pull request Sep 13, 2019
@miss-islington @kianasun
Doc: Improve consistency of os.path.normcase with other os.path funct…
60d5e2c 
…ions (GH-14004)

(cherry picked from commit 53f78ec)

Co-authored-by: Kexuan Sun <me@kianasun.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@mangrisano mangrisano mangrisano approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@kianasun @asvetlov @willingc @miss-islington @bedevere-bot @matrixise @mangrisano @the-knights-who-say-ni