Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document data types #7

Open
AleMorales opened this issue Nov 15, 2023 · 0 comments
Open

Document data types #7

AleMorales opened this issue Nov 15, 2023 · 0 comments

Comments

@AleMorales
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant