Report DocString error on named return paramater mismatch - #7837
Merged
Conversation
This was referenced Nov 28, 2019
erak
force-pushed
the
docstring-named-return
branch
from
November 28, 2019 15:56
d65fdde to
507230f
Compare
erak
commented
Nov 28, 2019
| } | ||
|
|
||
| /// @dev Allows to withdraw fees from market contract to campaign contract | ||
| /// @return Fee amount |
Collaborator
Author
There was a problem hiding this comment.
This function does not return anything.
erak
force-pushed
the
docstring-named-return
branch
3 times, most recently
from
November 28, 2019 16:23
7e26179 to
4445d47
Compare
leonardoalt
force-pushed
the
docstring-named-return
branch
from
December 3, 2019 20:30
4445d47 to
03097fb
Compare
|
Rebased for now |
axic
reviewed
Dec 3, 2019
leonardoalt
force-pushed
the
docstring-named-return
branch
2 times, most recently
from
December 4, 2019 10:47
ef185f5 to
c72faf3
Compare
Contributor
|
Tests are failing. |
chriseth
force-pushed
the
docstring-named-return
branch
from
December 4, 2019 14:40
c72faf3 to
19d466d
Compare
chriseth
approved these changes
Dec 4, 2019
leonardoalt
approved these changes
Dec 4, 2019
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
4 participants
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.
Part of #7835.
Changelog and documentation was already updated with #7534. This is just making it report a parser error instead of silently accepting it and then throwing an ICE when
--devdocis passed tosolc.Implementation detail
Whenever a
@returntag is visited, the list of named return parameters is checked for at least one matching name.We do not care of enforce the order of them.EDIT:
We do care about the order of named / unnamed return parameters and their corresponding documentation tag (as required by #7534 already). This PR also requires that the number of return parameters and
@returntags is equal.