Skip to content

1st line of the math.perm docstring doesn't mention a default value for k #101592

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

Closed
skirpichev opened this issue Feb 6, 2023 · 2 comments
Closed
Labels
docs Documentation in the Doc dir

Comments

@skirpichev
Copy link
Contributor

Here is an example how this looks in the IDLE:
1

While full docstring and the sphinx docs looks fine, the first line doesn't describe the function signature correctly.

Originally posted by @skirpichev in #89381 (comment)

@skirpichev skirpichev added the docs Documentation in the Doc dir label Feb 6, 2023
@rhettinger
Copy link
Contributor

I think this is unimportant. There is only a limited amount of information that can be squeezed into the first line. The default k=None is the least important case and its functionality is duplicated by factorial.

So, I'll mark this one as "don't worry about it".

@rhettinger rhettinger closed this as not planned Won't fix, can't repro, duplicate, stale Feb 10, 2023
@skirpichev
Copy link
Contributor Author

There is only a limited amount of information that can be squeezed into the first line.

Sure, I realize that.

The default k=None is the least important case

The point is that it's not an obvious default value, as it was noted by @serhiy-storchaka in #81359. IMHO, even less obvious than the log case, where that was an issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

2 participants