-
Notifications
You must be signed in to change notification settings - Fork 252
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document exceptions raised by functions in utils #544
Conversation
Maybe we should change that? No reason to keep the exceptions undocumented. |
@brettcannon Anything else? Is the style / wording acceptable? |
Nope, just me not being sick so I had time to review. 😅 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's best to keep the docs for exceptions generic in case other code uses the exceptions in the future.
Apologies for taking so long to get to this! Luckily 3.11.0.rc1 is getting cut today and I caught up to my review queue so I'm apparently only backed up until PRs created in May 😅. |
Head branch was pushed to by a user without write access
Fixed. Thanks :). Edit: also linearized the log, fixed a missing word. |
236029b
to
3f9b5c5
Compare
3f9b5c5
to
170fde8
Compare
Also applied suggestions from code review Co-authored-by: Brett Cannon <brett@python.org>
170fde8
to
5839a3f
Compare
Thanks! |
Closes #543.
Added
:raises ...:
clauses to documentation of functions frompackaging.utils
.Class names have been given by their full import path, since they are not mentioned anywhere else in the documentation.