Update documentation, clean up package level documentation #173
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
njason
requested changes
Apr 27, 2020
| // Only operations are assign and (binary) left/right shift. | ||
| // Can do binary floating point in multiprecision decimal precisely | ||
| // because 2 divides 10; cannot do decimal floating point | ||
| // in multiprecision binary precisely. | ||
| package decimal |
There was a problem hiding this comment.
I think just adding an extra newline will omit the comments from godoc: Comments that are not adjacent to a top-level declaration are omitted from godoc's output https://blog.golang.org/godoc
It would be good to keep the comments in this file and rounding.go and not have them show up in godoc if we can
There was a problem hiding this comment.
Great, I had no idea about that. I will fix it after work. :3
|
Yes, you were right Jason, adding new line was enough, |
njason
approved these changes
Apr 28, 2020
njason
approved these changes
Apr 28, 2020
fairyhunter13
added a commit
to fairyhunter13/decimal
that referenced
this pull request
Jul 12, 2020
…g#173) * Update documentation, clean up package level documentation
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.
Few things changes since we start maintaining this library, so let's update docs.
This PR also should improve go report cards.
Btw. I removed package docs from
decimal-goandroundingmodules to improve godoc. Should I transfer those docs todecimalmodule or just remove it?