Converting docstrings to NatSpec format #160
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
bal7hazar
suggested changes
Feb 19, 2023
There was a problem hiding this comment.
Nice job
-
Missing a cap letter for param and return description, for instance:
@param test this is a testmust be@param test This is a test -
Short description must be in imperative mood:
@notice Returns somethingmust be@notice Return something -
If possible, try to add an article in param and return description:
@param test Testmust be@param test The test
bal7hazar
suggested changes
Feb 20, 2023
bal7hazar
suggested changes
Feb 20, 2023
bal7hazar
suggested changes
Feb 20, 2023
bal7hazar
suggested changes
Feb 21, 2023
|
It took me around 3 hours. |
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.
No description provided.