[BREAKING] Allow NatSpec comments for state variables. #8749
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
aarlt
force-pushed
the
structured-docs-variables-aarlt-breaking
branch
from
a1d681d
to
2fdcde4
Compare
|
Please also see the last comments on #3418. |
hrkrshnn
requested changes
May 5, 2020
aarlt
force-pushed
the
structured-docs-variables-aarlt-breaking
branch
6 times, most recently
from
904875a
to
e7aa7fb
Compare
aarlt
commented
May 20, 2020
| @@ -254,7 +254,7 @@ BOOST_AUTO_TEST_CASE(natspec_comment_in_function_body) | |||
| /// fun1 description | |||
| function fun1(uint256 a) { | |||
| var b; | |||
| /// I should not interfere with actual natspec comments | |||
| // I should not interfere with actual natspec comments (natspec comments on local variables not allowed anymore) | |||
There was a problem hiding this comment.
Maybe we should remove the comments?
There was a problem hiding this comment.
Maybe then we should have tests that do interfere with actual natspec comments? (or do we already have those?)
There was a problem hiding this comment.
@aarlt do we have tests like my previous comment?
There was a problem hiding this comment.
@leonardoalt at least here there will be no interference possible, because it is just forbidden now on local variables. But maybe we can add some natspecs to other expressions within a function body, I'm not sure whether it will make sense. However, I will check that.
aarlt
force-pushed
the
structured-docs-variables-aarlt-breaking
branch
2 times, most recently
from
ff6b2d0
to
bbab19c
Compare
- changing some warnings to errors
aarlt
force-pushed
the
structured-docs-variables-aarlt-breaking
branch
from
bbab19c
to
cb5bfc7
Compare
leonardoalt
approved these changes
Jun 10, 2020
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.
See #8532.
This PR will replace some warnings with errors.