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

documentation for BigFloat #41215

Open
alanedelman opened this issue Jun 13, 2021 · 2 comments
Open

documentation for BigFloat #41215

alanedelman opened this issue Jun 13, 2021 · 2 comments
Labels
domain:bignums BigInt and BigFloat domain:docs This change adds or pertains to documentation

Comments

@alanedelman
Copy link
Contributor

In looking at the doc for BigFloats etc
, couldn't find the default (256), and kind of a clue how to find it, but in a too vague way.
Suggest putting the default of 256 bits early in the doc, or at least, an example of what to type to find out.

@mgkuhn mgkuhn added the domain:docs This change adds or pertains to documentation label Jun 14, 2021
@mgkuhn
Copy link
Contributor

mgkuhn commented Jun 14, 2021

Adding a line-break in the 128-characters long function signature at the start of that docstring would make the precision::Integer=precision(BigFloat) keyword and its default value visible in HTML without horizontal scrolling.

More general issue: no pre-formatted line in a docstring should be longer than 80 characters.

@JeffreySarnoff
Copy link
Contributor

We should avoid implying that BigFloats means 256 bits unless the user calls setprecision(BigFloat,n) . That is how Julia initializes BigFloat precision today. It may change tomorrow.

@ViralBShah ViralBShah added the domain:bignums BigInt and BigFloat label Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:bignums BigInt and BigFloat domain:docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

4 participants