Basics: Add documentation note to radians function. #1040
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
Change 'Convert' to 'Represent', as the function does not perform conversion. References elm/elm-lang.org#713.
downloadpizza
suggested changes
Aug 27, 2019
| same as the input. Despite merely returning its input, the [`radians`](#radians) | ||
| function is still useful: it adds semantics to angle values. For example: | ||
|
|
||
| angle = radians 3.14 |
There was a problem hiding this comment.
there should be an "or" between the two somewhere as with the current wording it is implied that they are a single statement. (Yes, anyone who can think gets what it means but it would still be better with an "or")
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.
Change 'Convert' to 'Represent', as the function does not perform
conversion.
The documentation of the
radiansfunction has confused a few people - why have a function simply return its input? Per the discussion in elm/elm-lang.org#713, add a note to the documentation explaining the value of theradiansfunction.References elm/elm-lang.org#713.