docs: suggestions, polish #59
Open
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
sohkai
commented
Sep 5, 2020
| @@ -1,12 +1,12 @@ | |||
| # External interface | |||
|
|
|||
| // Note: is there any point in this file if it's just duplicating the entry points? | |||
There was a problem hiding this comment.
Didn't find this file useful, since the entry points seem to already cover this.
Perhaps we should either dedupe, or discuss which events are emitted instead?
sohkai
commented
Sep 5, 2020
| @@ -1,5 +1,6 @@ | |||
| # Testing guide | |||
There was a problem hiding this comment.
I saw the issue in #35, but I'm not sure there's much point in having this in the docs since there's not a lot of setup needed. Perhaps we should move this to be with the contract's README?
sohkai
commented
Sep 5, 2020
| @@ -276,15 +265,16 @@ Transfer `_amount` tokens from `_from`'s lock by `msg.sender` to `_to` | |||
| - Checks that contract has been initialized | |||
| - Check that owner’s lock is enough | |||
| - Checks that amount input is not zero | |||
| // Note: for these next three functions that involve amounts, shouldn't we also have pre-conditions for checking the amount is inside a bound? | |||
There was a problem hiding this comment.
Just wanted to sanity check, since we explicitly state it elsewhere, should we declare checks on the amounts / balances as preconditions here?
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.
Does a round of polish on the current readmes, docs.