Skip to content

Document data types #7

@AleMorales

Description

@AleMorales

At the moment we do not document the structure of objects that the user will own, which makes it harder for them to work with said objects. We should define access functions for all of them (rather than relying on dot notation) but this should documented somewhere.

Proposal:

  • Always document the type of object returned by a function

  • Add a docstring for the data type itself pointing at the access functions

  • Document the access functions

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationshortFixing this issue will NOT take a significant amount of time

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions