Add a reference to String.to_integer in the doc #4781
Merged
Conversation
This file contains hidden or 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
| Raises an error if `base` is less than 2 or more than 36. | ||
| If an integer formatted string wants to be directly converted to a integer, | ||
| `String.to_integer/1` or `String.to_integer/2` can be used instead. |
Member
There was a problem hiding this comment.
The wording at the beginning of the sentence is kind of off (in the Float module as well, not your fault 😛). What if we say
If you want to convert a string-formatted integer directly to an integer,
String.to_integer/1orString.to_integer/2can be used instead.
Same thing would go for the Float module, it would be great if you changed that as well in this PR :) Wdyt?
Contributor
Author
There was a problem hiding this comment.
Thanks, I totally agree. I found the wording a bit weird too but went for consistency first. But you're right, the boy scout rule should prevail, I'll update both docs.
Member
|
❤️ 💚 💙 💛 💜 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The documentation for
Float.parsehas a mention ofString.to_float, this patch adds a similar reference forInteger.parsein the function documentation.