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.

Sign up for GitHub

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

Jump to bottom

API Docs: std::floating point stuff #29353

Closed
1 task
steveklabnik opened this issue Oct 26, 2015 · 5 comments
Closed
1 task

API Docs: std::floating point stuff #29353

steveklabnik opened this issue Oct 26, 2015 · 5 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. P-medium Medium priority

Comments

@steveklabnik
Copy link
Member

steveklabnik commented Oct 26, 2015 •
edited
Loading

Part of #29329

like http://doc.rust-lang.org/std/f32/ pretty sure these are generated too, for all of them.

Here's what's needed to close out this issue:
@steveklabnik steveklabnik mentioned this issue Oct 26, 2015
Closed
51 tasks
@steveklabnik steveklabnik added the E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. label Mar 8, 2017
@steveklabnik
Copy link
Member Author

I am happy to mentor anyone who wants to tackle this issue.

@steveklabnik steveklabnik added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Mar 10, 2017
@steveklabnik steveklabnik added E-help-wanted Call for participation: Help is requested to fix this issue. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. P-medium Medium priority E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. and removed A-docs labels Mar 24, 2017
@palango
Copy link
Contributor

palango commented Mar 25, 2017

Hej @steveklabnik , what do you think about the following description?

This module provides access to properties and bounds of this floating point data type. Furthermore mathematical constants are provided in the consts module.

@steveklabnik
Copy link
Member Author

Hey @palango,

I like it. We should ask @rust-lang/libs though, why are some of these constants in consts and some are not?

@palango
Copy link
Contributor

palango commented Mar 27, 2017

I guess the std::f32 module is for data-type specific constants, whereas std::f32::consts is for mathematical constants with the possible accurcy.

@palango palango mentioned this issue Apr 6, 2017
Merged
palango added a commit to palango/rust that referenced this issue Apr 11, 2017
@palango
Improve module description for std::f32 and std::f64.
4b4b1e1 
Fixes rust-lang#29353
bors added a commit that referenced this issue Apr 14, 2017
@bors
Auto merge of #41122 - palango:mod-desc-floats, r=frewsxcv
5637ed7 
Improve module description for std::f32 and std::f64

Fixes #29353, see discussion there.
@frewsxcv
Copy link
Member

Do we want to consider #41122 a full solution here? Do we want to expand the docs a bit more?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. P-medium Medium priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@steveklabnik @palango @frewsxcv