Extra line of explanation on Abstract contracts. #4101
Merged
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
And why they're useful.
chriseth
reviewed
May 9, 2018
docs/contracts.rst
Outdated
| @@ -1145,6 +1145,8 @@ Example of a Function Type (a variable declaration, where the variable is of typ | |||
|
|
|||
| Abstract contracts decouple the definition of a contract from its implementation providing better extensibility and self-documentation and | |||
| facilitating patterns like the `Template method <https://en.wikipedia.org/wiki/Template_method_pattern>`_ and removing code duplication. | |||
| Abstract contracts are useful in the same way that defining methods in an Interface is useful. It's a way for the designer of the Abstract contract to say "any child of mine MUST implement this method". | |||
There was a problem hiding this comment.
Please do not needlessly capitalize words, we use abstract and interface just like regular words. Also please do not use contractions.
There was a problem hiding this comment.
I'll edit the capitalization. What "contractions" do you mean?
There was a problem hiding this comment.
It's - this is written and not spoken text.
There was a problem hiding this comment.
@chriseth Thanks. Fixed both issues.
chriseth
approved these changes
May 16, 2018
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.
And why they're useful.