Add some documentation for the method arb #71
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
Related to ProofSuite#70 From the issue description I have added some paragraphs to the README.md explaining the arb function after a primer and provided a parameter by parameter explaination of the arbs accepted params. I found an already done example on using the arb function with Aave flash loans and provided an example of that.
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.
Related to #70
From the issue description I have added some paragraphs to the README.md explaining the arb function after a primer and provided a parameter by parameter explaination of the arbs accepted params.
I found an already done example on using the arb function with Aave flash loans and provided an example of that.
After going through the provided videos on the issue description this is an interesting project. Point out any parts of the provided docs that could be better and I will do my best.