Improve docs of big module overloads #6336
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
|
Convention is to add |
|
@Sija These are methods added to |
|
@laginha87 Please rebase this PR's branch against master, CI is failing because of things that are already fixed in master. |
laginha87
force-pushed
the
laginha87-improve-big-docs
branch
from
714de7c to
d7fec28
Compare
ghost
reviewed
Jul 5, 2018
src/big/big_float.cr
Outdated
| @@ -298,6 +304,12 @@ module Math | |||
| {frac, exp} | |||
| end | |||
|
|
|||
| # Returns the sqrt of a `BigInt`. | |||
RX14
approved these changes
Jul 7, 2018
RX14
added
kind:bug
RX14
requested changes
Jul 7, 2018
…sses that are part of the standard library
laginha87
force-pushed
the
laginha87-improve-big-docs
branch
from
d7fec28 to
fbcaf58
Compare
|
@RX14, @BenDietze thanks for looking into the PR, I made the requested change and rebased on master again, should be good to go. |
RX14
approved these changes
Jul 10, 2018
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.
Fix for #6226 by adding code examples to the docs that import the
bigmodule.It was also mentioned in the issue to improve the error message in case of overflow, but from what I looked at the code it seems like there is no simple way to add that without changing the code significantly.
https://github.com/crystal-lang/crystal/blob/e806c95/src/string.cr#L407