argotorg / argotorg/solidity

[AST] Consider expanding the use of NatSpec documentation to all declarations.

Open
#12,295 23 comments 5 reactions 1 assignee Claimed by @veniger View on GitHub
medium effort medium impact must have eventually natspec
Dominant language
C++
Stars
25.7k
Forks
6.2k
Avg merge
1d 11h
Merged PRs (30d)
21

Description

The motivation behind is, to be able to display additional information about a declaration, not just its type signature.

This might also help documentation.

The relevant AST nodes I'd at least expand to are:

- [x] struct definitions
- [x] enum definitions
- [ ] enum value definitions
- [ ] UDVTs
- [ ] ASTJSON tests for custom errors
- [ ] modules
- [ ] `constant` variable definitions

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.