Skip to content
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

DOC: Clarify randint and integers doc #26106

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bashtage
Copy link
Contributor

Improve doc strings to include multiple signatures Clean up docstring generally

closes #9573

Improve doc strings to include multiple signatures
Clean up docstring generally

closes numpy#9573
@bashtage
Copy link
Contributor Author

Need to see how this renders in the docbuild.

@charris charris added the 09 - Backport-Candidate PRs tagged should be backported label Mar 22, 2024
@charris
Copy link
Member

charris commented Mar 22, 2024

Doesn't render correctly. The first docstring line gets appended to the signature. This might be a numpydoc problem, not sure how multiple signatures should be marked up.

@seberg
Copy link
Member

seberg commented Mar 22, 2024

Maybe @rossbar has a suggestion (or maybe it should also use [] style in the signature).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
04 - Documentation 09 - Backport-Candidate PRs tagged should be backported
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusing argument order for random.randint
3 participants