Skip to content

Ensure all internal structs that are exposed publically are fully documented #2177

@yuandrew

Description

@yuandrew

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
There are a number of internal structs that are exposed publicaly, but have missing docs for their fields, like

ActivityInfo struct {

Describe the solution you'd like
Should go through and ensure these are all documented, this mainly won't require writing new docs, but simply copying other instances of usages of it's docs, saving developers from having to search the codebase to find docs for the same field in a different struct.

It would also be nice to enhance the doclink tool to identify and enforce this

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions