Skip to content

make exp_m1 and ln_1p examples more representative of use - #77099

Merged
bors merged 2 commits into
rust-lang:masterfrom
tspiteri:exp_m1-examples
Oct 31, 2020
Merged

make exp_m1 and ln_1p examples more representative of use#77099
bors merged 2 commits into
rust-lang:masterfrom
tspiteri:exp_m1-examples

Conversation

@tspiteri

@tspiteritspiteri commented Sep 23, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

With this PR, the examples for exp_m1 would fail if x.exp() - 1.0 is used instead of x.exp_m1(), and the examples for ln_1p would fail if (x + 1.0).ln() is used instead of x.ln_1p().

@rust-highfive

rust-highfive commented Sep 23, 2020

Copy link
Copy Markdown
Contributor

r? @sfackler

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 23, 2020
@tspiteritspiteri changed the title make exp_m1 examples more representative of usemake exp_m1 and ln_1p examples more representative of useSep 23, 2020
@tspiteri
make exp_m1 examples more representative of use
37ce212
With this commit, the examples for exp_m1 would fail if x.exp() - 1.0
is used instead of x.exp_m1().
@tspiteri
make ln_1p examples more representative of use
50d3ddc
With this commit, the examples for ln_1p would fail if (x + 1.0).ln()
is used instead of x.ln_1p().
@sfackler

sfackler commented Sep 23, 2020

Copy link
Copy Markdown
Member

r? @rust-lang/docs

@steveklabnik

steveklabnik commented Sep 23, 2020

Copy link
Copy Markdown
Contributor

Honestly, I never use these functions so I have no idea if this is an improvement or not.

@tspiteri

tspiteri commented Sep 23, 2020

Copy link
Copy Markdown
ContributorAuthor

As far as I know, both functions are there basically to provide more accuracy when the operand is close to zero, so my thinking was that the example should use an operand that is close to zero. And if someone tries to modify the examples to use the other (exp and ln) functions instead, they will be able to see what the point of these functions is.

@jyn514jyn514 added A-floating-point Area: Floating point numbers and arithmetic A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Oct 13, 2020
@Dylan-DPC-zz

Dylan-DPC-zz commented Oct 13, 2020

Copy link
Copy Markdown

r? @steveklabnik

@steveklabnik

steveklabnik commented Oct 13, 2020

Copy link
Copy Markdown
Contributor

I still have not used these functions and so don't know if it's an improvement, so I shouldn't be the reviewer.

@m-ou-sem-ou-se assigned m-ou-se and unassigned steveklabnikOct 30, 2020
@m-ou-se

m-ou-se commented Oct 30, 2020

Copy link
Copy Markdown
Member

Nice, those are much better examples for these functions.

would fail if __ is used instead of __

Do you think it would be good to show that in the examples as well?

@tspiteri

tspiteri commented Oct 30, 2020

Copy link
Copy Markdown
ContributorAuthor

would fail if __ is used instead of __

Do you think it would be good to show that in the examples as well?

My concern is that maybe then the examples might become a bit too cluttered/daunting. At least I did not find a way to show this in the examples that satisfied me.

@m-ou-se

m-ou-se commented Oct 30, 2020

Copy link
Copy Markdown
Member

Alright, makes sense.

Thanks for the improvement.

@bors r+ rollup

@bors

bors commented Oct 30, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit 50d3ddc has been approved by m-ou-se

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 30, 2020
@jonas-schievinkjonas-schievink mentioned this pull request Oct 30, 2020
Closed
m-ou-se added a commit to m-ou-se/rust that referenced this pull request Oct 30, 2020
@m-ou-se
Rollup merge ofrust-lang#77099- tspiteri:exp_m1-examples, r=m-ou-se
286e295
make exp_m1 and ln_1p examples more representative of use
With this PR, the examples for `exp_m1` would fail if `x.exp() - 1.0` is used instead of `x.exp_m1()`, and the examples for `ln_1p` would fail if `(x + 1.0).ln()` is used instead of `x.ln_1p()`.
@m-ou-sem-ou-se mentioned this pull request Oct 30, 2020
Closed
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Oct 31, 2020
@Dylan-DPC
Rollup merge ofrust-lang#77099- tspiteri:exp_m1-examples, r=m-ou-se
fcffbcf
make exp_m1 and ln_1p examples more representative of use
With this PR, the examples for `exp_m1` would fail if `x.exp() - 1.0` is used instead of `x.exp_m1()`, and the examples for `ln_1p` would fail if `(x + 1.0).ln()` is used instead of `x.ln_1p()`.
@Dylan-DPC-zzDylan-DPC-zz mentioned this pull request Oct 31, 2020
Closed
m-ou-se added a commit to m-ou-se/rust that referenced this pull request Oct 31, 2020
@m-ou-se
Rollup merge ofrust-lang#77099- tspiteri:exp_m1-examples, r=m-ou-se
a56422e
make exp_m1 and ln_1p examples more representative of use
With this PR, the examples for `exp_m1` would fail if `x.exp() - 1.0` is used instead of `x.exp_m1()`, and the examples for `ln_1p` would fail if `(x + 1.0).ln()` is used instead of `x.ln_1p()`.
This was referenced Oct 31, 2020
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 31, 2020
@bors
Auto merge ofrust-lang#78594- m-ou-se:rollup-h5c8frs, r=m-ou-se
4f7612a
Rollup of 7 pull requests
Successful merges:
- rust-lang#74622 (Add std::panic::panic_any.)
- rust-lang#77099 (make exp_m1 and ln_1p examples more representative of use)
- rust-lang#78526 (Strip tokens from trait and impl items before printing AST JSON)
- rust-lang#78550 (x.py setup: Create config.toml in the current directory, not the top-level directory)
- rust-lang#78577 (validator: Extend aliasing check to a call terminator)
- rust-lang#78581 (Constantify more BTreeMap and BTreeSet functions)
- rust-lang#78587 (parser: Cleanup `LazyTokenStream` and avoid some clones)
Failed merges:
r? `@ghost`
@bors
bors merged commit 4ebd553 into rust-lang:masterOct 31, 2020
@rustbotrustbot added this to the 1.49.0 milestone Oct 31, 2020
@tspiteri
tspiteri deleted the exp_m1-examples branch October 31, 2020 20:03
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@m-ou-sem-ou-se

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsA-floating-pointArea: Floating point numbers and arithmeticS-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

1.49.0

Development

Successfully merging this pull request may close these issues.

9 participants

@tspiteri@rust-highfive@sfackler@steveklabnik@Dylan-DPC-zz@m-ou-se@bors@jyn514@rustbot