smartcontract: fix DO NOT EDIT warning to autogenerated files #3280
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
AliceInHunterland
requested review from
AnnaShaleva and
roman-khimov
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3280 +/- ##
==========================================
- Coverage 85.30% 85.21% -0.10%
==========================================
Files 327 327
Lines 44153 44248 +95
==========================================
+ Hits 37664 37705 +41
- Misses 5001 5047 +46
- Partials 1488 1496 +8 ☔ View full report in Codecov by Sentry. |
| @@ -60,7 +60,9 @@ const ( | |||
| // verification contract is circuit-specific, i.e. corresponds to a specific | |||
| // single constraint system. Thus, every new circuit requires vew verification | |||
| // contract to be generated and deployed to the chain. | |||
| goVerificationTmpl = `// Package main contains verification smart contract that uses Neo BLS12-381 | |||
| goVerificationTmpl = `//Code generated by neo-go zkpbinding.GenerateVerifier; DO NOT EDIT. | |||
| // | |||
There was a problem hiding this comment.
but not be attached to the package clause
So it has to be a separate comment, right?
There was a problem hiding this comment.
Does it mean it needs space between two comments?
There was a problem hiding this comment.
I think so. Try finding some similar tools and check how exactly it's structured there.
Like
// Code generated by "stringer -type=Role"; DO NOT EDIT.
But this doesn't have package-level documentation, unfortunately. My primary concern is correct package doc. You can check it with godoc though.
The text must appear as the first line of a properly formatted Go // comment, and that comment must appear before but not be attached to the package clause and before any /* */ comment. Closes #3254 Signed-off-by: Ekaterina Pavlova <[email protected]>
AliceInHunterland
force-pushed
the
do_not_edit
branch
from
bcacde2 to
1237c71
Compare
roman-khimov
approved these changes
Dec 25, 2023
AnnaShaleva
approved these changes
Dec 25, 2023
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.
Change the order of comments
Closes #3254