Skip to content
This repository was archived by the owner on Apr 28, 2025. It is now read-only.

Add some more basic docstrings#352

Merged
tgross35 merged 9 commits into
rust-lang:masterfrom
JSorngard:docstrings
Nov 1, 2024
Merged

Add some more basic docstrings#352
tgross35 merged 9 commits into
rust-lang:masterfrom
JSorngard:docstrings

Conversation

@JSorngard

Copy link
Copy Markdown
Contributor

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

@JSorngard

JSorngard commented Oct 31, 2024

Copy link
Copy Markdown
Contributor Author

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.

Comment thread src/math/lgamma.rs Outdated
@tgross35

Copy link
Copy Markdown
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
Copy Markdown
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

@tgross35 tgross35 left a comment

Copy link
Copy Markdown
Contributor

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
@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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants