fix: convert HRC-904 example doc tags from // to /// for NatSpec - #132
Merged
natanasow merged 4 commits intoAug 20, 2026
Merged
Conversation
Signed-off-by: ValentinVPK <valentin.krumov@limechain.tech>
natanasow
approved these changes
Aug 18, 2026
…-tags Signed-off-by: ValentinVPK <valentin.krumov@limechain.tech>
Contributor
|
🎉 This PR is included in version 0.2.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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
3 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.
Description:
Convert the HRC-904 example doc tags from
//to///sosolcparses them as NatSpec. The tags were complete but written with two slashes, so none of the docs reached userdoc/devdoc, explorers, or IDE hovers.//doc-comment lines (@taglines and their free-text continuations) to///inAirdrop,CancelAirdrop,ClaimAirdrop, andTokenReject// SPDX-License-Identifierlines untouchedRelated issue(s):
Fixes #127
Notes for reviewer:
Docs-only change — no runtime/ABI impact. Diff is a pure
//→///swap (146 insertions / 146 deletions). Verified withnpx hardhat compile: solc now emitsuserdoc/devdocfor all four contracts (e.g.TokenReject→ contract@notice+ 4 documented methods + 13@paramentries), whereas before they were empty.