Improve docs for abs, abs2
#45141
Merged
Improve docs for abs, abs2
#45141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stevengj
reviewed
May 2, 2022
KristofferC
reviewed
May 2, 2022
KristofferC
reviewed
May 2, 2022
KristofferC
reviewed
May 2, 2022
KristofferC
reviewed
May 2, 2022
KristofferC
reviewed
May 2, 2022
Co-authored-by: Steven G. Johnson <stevenj@mit.edu>
|
@mcabbott Is this ready from your perspective? I feel the comments are adequately addressed and I would be comfortable to merge. |
|
@KristofferC You had some concerns above - I feel this is good to merge and overall makes the documentation more accessible. |
|
Sorry I missed your earlier comment. From my side this seems OK; also fine to delete the |
Co-authored-by: Michael Abbott <32575566+mcabbott@users.noreply.github.com>
|
CI is on a hiatus at the moment, but if we get a pass on doctest, let's merge. |
mcabbott
commented
Jul 26, 2022
ffucci
pushed a commit
to ffucci/julia
that referenced
this pull request
Aug 11, 2022
Co-authored-by: Steven G. Johnson <stevenj@mit.edu> Co-authored-by: Viral B. Shah <ViralBShah@users.noreply.github.com>
pcjentsch
pushed a commit
to pcjentsch/julia
that referenced
this pull request
Aug 18, 2022
Co-authored-by: Steven G. Johnson <stevenj@mit.edu> Co-authored-by: Viral B. Shah <ViralBShah@users.noreply.github.com>
LilithHafner
added a commit
that referenced
this pull request
Feb 12, 2024
This extends the docs for `Int`, `Float64` etc, to * Note that Int is the default, mention that it can overflow * Explain what `1f0` means, and that Float64 is the default Similarly extends docs for `^`, `+`, `*` aiming to * Point out that `1.2 * 10^3` is a bad habit, warn about overflow * Give an example for what `literal_pow` is doing since the explanation is quite technical * Also point out overflow in `+`, as [suggested here](#45141 (comment)) * While there, mention that you can add vectors, and that vararg `+(1,2,3,4)` has a default binary behaviour * Similarly mention that vararg `*(1,2,3,4)` has a default order, from the left * While there, mention `1/2pi` and `v'v` as examples of `*`. --------- Co-authored-by: Lilith Orion Hafner <lilithhafner@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds some examples for
abs,abs2, since someone in this thread started at the beginning of the alphabet...