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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #127

Open
charleskawczynski opened this issue Oct 16, 2024 · 0 comments
Open

Improve documentation #127

charleskawczynski opened this issue Oct 16, 2024 · 0 comments

Comments

@charleskawczynski
Copy link
Member

I think we can improve the documentation by including a bit more type information, and by including more copy-paste-friendly examples. I've found some of the documentation to gloss over the types of variables, or assume that some variables exist, and it makes the examples hard to understand / reproduce.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@charleskawczynski