chore(docs): Add examples to Number module
#2015
Merged
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
spotandjake
requested review from
ospencer,
phated,
peblair,
marcusroberts and
jozanza
as code owners
alex-snezhko
approved these changes
Feb 17, 2024
|
Let's make sure something akin to #2032 is merged before we land this. |
phated
requested changes
Feb 22, 2024
spotandjake
force-pushed
the
spotandjake-number-docs
branch
from
824e16b
to
2cb30b8
Compare
|
@spotandjake more conflicts (due to atan2?) |
spotandjake
force-pushed
the
spotandjake-number-docs
branch
from
deb22de
to
f424643
Compare
phated
approved these changes
Mar 3, 2024
phated
changed the title
Number docsNumber module
ospencer
reviewed
Mar 3, 2024
| @@ -337,6 +409,13 @@ provide let isInteger = (x: Number) => { | |||
| * @param x: The number to check | |||
| * @returns `true` if the value is a non-integer rational number or `false` otherwise | |||
| * | |||
| * @example Number.isRational(1/2) | |||
Comment on lines
+433
to
+436
| * @example Number.isFinite(1/2) | ||
| * @example Number.isFinite(0.5) | ||
| * @example Number.isFinite(1.0) | ||
| * @example Number.isFinite(1) |
There was a problem hiding this comment.
Or is this our style? Just feels a little weird since it's not an assertion.
There was a problem hiding this comment.
I haven't been paying that close of attention. I know jake was doing assert in some cases.
There was a problem hiding this comment.
We have been using assert semantics for single line matches throughout the stdlib.
There was a problem hiding this comment.
@spotandjake why don't these contain assert then?
ospencer
approved these changes
Mar 3, 2024
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 pr improves the documentation on the
Numbermodule, by adding examples to most functions. It also adds a missingsinceproperty toNumber.sign.Notes:
Rangeuntil we have proper syntax.sin,cos,tan,gamma,factorialfunctions #1478 had been an issue to makeNumber.sinunbounded, but I noticed during this pr that was not the actual problem, the problem is how we map the input range and also with our implementation.