Skip to content

NatSpec inheritance and transclusion #262

@ItsNickBarry

Description

@ItsNickBarry

NatSpec comments are generally needed on both external interfaces and internal contracts. External contracts inherit their comments from external interfaces. In cases where internal functions correspond to external functions (in accordance with the layers pattern), these comments should be identical.

We need a script (or at least a test) to make sure that no comments are missing, and that they are consistent across contracts. Ideally it would also find cases where inheritdoc can be used for overridden internal functions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions