This repository has been archived by the owner on Jan 13, 2023. It is now read-only.
Add docstrings and additional comments #234
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
BrendanChou
force-pushed
the
bc_docstring
branch
from
666c41b to
b707267
Compare
BrendanChou
force-pushed
the
bc_docstring
branch
from
b707267 to
11abb2e
Compare
AntonioJuliano
suggested changes
Apr 12, 2019
contracts/protocol/Getters.sol
Outdated
| * | ||
| * @param marketId The market to query | ||
| * @return The current market info, including: | ||
| * - The ERC20 token address |
There was a problem hiding this comment.
since we're using AbiEncoderV2 these will be returned as structs with named paramaters. It would be a lot more helpful to see this as:
{
keyA: description of keyA,
keyB: description of keyB
}
| * | ||
| * @param accounts A list of all accounts that will be used in this operation. Cannot contain | ||
| * duplicates. In each action, the relevant account will be referred-to by its | ||
| * index in the list. |
There was a problem hiding this comment.
it'd be very helpful to see at a glance here the structure of an Account.Info. Also of the form:
{
keyA: descA,
keyB: descB
}
Same for actions and Actions.ActionArgs
| * duplicates. In each action, the relevant account will be referred-to by its | ||
| * index in the list. | ||
| * @param actions An ordered list of all actions that will be taken in this operation. The | ||
| * actions will be processed in order. |
There was a problem hiding this comment.
[not this line] it'd be really helpful to have detailed comments on each action type and what all the fields for that struct mean
added 2 commits
April 12, 2019 17:10
BrendanChou
force-pushed
the
bc_docstring
branch
from
f86de26 to
babd773
Compare
AntonioJuliano
suggested changes
Apr 15, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes #199