NatSpec v2
- Dominant language
- C++
- Stars
- 25.7k
- Forks
- 6.2k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 29
Description
Natspec JSON changes (non-breaking):
- [ ] #11114 (events and errors as arrays instead of hashmap)
- [ ] #11120 (change params/returns into an array instead of hashmap)
- [x] #11158 (include events/errors in the devdoc)
- [ ] include the `@notice` in the devdoc too
Natspec syntax changes (potentially breaking -- maybe has to wait for 0.9.0):
- [x] #10921 -- [explanation here](https://github.com/ethereum/solidity/issues/11156#issuecomment-810338240)
- [ ] disallow `@return` for events
Contributor guide
Research direction
Review the remaining checklist items and the linked issues #11114 and #11120, along with the completed work in #11158 and #10921. The work is done when the outstanding NatSpec JSON and syntax changes are implemented and their compatibility implications are resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, solidity
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100