fix(doc): vague verification description on MakerFeeRate and TakerFeeRate#32
Open
chen4903 wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
Principal
In general, we encourage the maker as he provides the liquidity, and "discourage" the taker as he takes away the liquidity. So the fee of maker should be less than taker.
Not clear description
But in spec ,the description is not clear: it should be False❌ in this context
In the code, it is:
Other description
Let's look at another description: it should be True✅ in this context
In the code, it is:
Summary
In the spec, similar descriptions like "Validate xxx is xxx than xxx" are used, but their semantics are not unified; sometimes they require
True, and sometimesFalse. This makes it confusing for readers to understand the spec. Therefore, I modified it to make it clearer.