python / cpython

The Python programming language
https://www.python.org
Other
63.67k stars 30.5k forks source link

Missing explanation about math.fmod #126719

Open Nodd opened 2 weeks ago

Nodd commented 2 weeks ago

Documentation

This issue was first raised in a PR, but it is preferred to be modified independently as per this comment. This issue is created to track the modification to add it later eventually.

This is the proposed modification:

+   Return the remainder of division ``x / y``,
+   as defined by the platform C library function ``fmod(x, y)``.
+
+   Note that the
-   Return ``fmod(x, y)``, as defined by the platform C library. Note that the
m3tal10 commented 2 weeks ago

Hey, I am new to Open Source Contributions. Can anyone assign it to me? I am willing to do this, need help and guidance to start my open-source contribution journey.

eendebakpt commented 2 weeks ago

Hi @m3tal10 , nice you are willing to help out. We typically do not assign issues to people, but you can start working on the issue and open a PR. Just post a message here you started working on the topic, so other contributors won't start on the same issue.

You can find more information on how to contribute on https://devguide.python.org/. If you need more help, then discourse.python.org is a good place to ask for help.

Also note that a PR has already been opened: https://github.com/python/cpython/pull/126337. A good start to open source contributions can also be to review the PR and learn from it.

Nodd commented 2 weeks ago

I would advise to wait for https://github.com/python/cpython/pull/126337 to be merged, to avoid conflicts. That's the problem with refactoring, conflicts get messy. That's why a created an issue in the first place, and not a PR.