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

(Re)move paragraph(s) about the differences with the C interface in the math module? #126722

Open
Nodd opened this issue Nov 12, 2024 · 2 comments
Labels
docs Documentation in the Doc dir

Comments

@Nodd
Copy link
Contributor

Nodd commented Nov 12, 2024

Documentation

The question is about these paragraphs, that are duplicated after the doc refactoring PR (one for modf and one for frexp):

Note that :func:`modf` has a different call/return pattern
than its C equivalents: it takes a single argument and return a pair of
values, rather than returning its second return value through an 'output
parameter' (there is no such thing in Python).

They should be either removed or moved to their corresponding function documentation.

The issue was raised in 2 pull request comments:

Note that the corresponding PR is not merged yet.

@ZeroIntensity
Copy link
Member

ZeroIntensity commented Nov 12, 2024

cc @skirpichev

Edit: nevermind, I didn't see that you already looked at the PRs.

@Nodd
Copy link
Contributor Author

Nodd commented Nov 12, 2024

I moved the notes next to their respective functions for now.

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
Status: Todo
Development

No branches or pull requests

2 participants