Skip to content

Add some more basic docstrings #352

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

Merged
merged 9 commits into from
Nov 1, 2024
Merged

Conversation

JSorngard
Copy link
Contributor

Adds docstrings to tgamma, tgammaf, lgamma, lgammaf, trunc, truncf, exp10, and exp10f. Related to #336.

@JSorngard
Copy link
Contributor Author

JSorngard commented Oct 31, 2024

Should I specify that trunc rounds to the nearest integer towards 0? I currently just tried to stay as faithful as I could to the documentation of musl's trunc function.

@tgross35
Copy link
Contributor

Should I specify that trunc rounds to the nearest integer towards 0? I currently just tried to stay as faithful as I could to the documentation of musl's trunc function.

Whatever you think would be helpful reading it :) there is no need to keep the wording from specifically musl, sources like e.g. cppreference likely have more thorough docs.

@JSorngard
Copy link
Contributor Author

Alright! I wrote it as clearly as I could and added a linebreak to the lgamma docstrings.

@tgross35 tgross35 enabled auto-merge (squash) November 1, 2024 12:09
Copy link
Contributor

@tgross35 tgross35 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@tgross35 tgross35 merged commit af009cc into rust-lang:master Nov 1, 2024
29 checks passed
@github-actions github-actions bot mentioned this pull request Nov 1, 2024
@JSorngard JSorngard deleted the docstrings branch November 1, 2024 12:36
tgross35 pushed a commit that referenced this pull request Apr 18, 2025
* Add docstrings to the tgamma functions
* Add docstrings to the lgamma functions
* Add docstrings to trunc
* Add docstrings to exp10 functions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants