Skip to content

Document all dataclass fields #633

Description

@Hritik14

Dataclasses expect having meaningful data and should be documented in code.
Eg:
The following should say what is expected in the aliases field.
https://github.com/nexB/vulnerablecode/blob/4390b6aca872cbde378516199f143fa11e64bc5a/vulnerabilities/importer.py#L192-L209

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationEverything about documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions