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

Breakup example.md into smaller clearer examples #23

Open
rofinn opened this issue Mar 17, 2021 · 1 comment
Open

Breakup example.md into smaller clearer examples #23

rofinn opened this issue Mar 17, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@rofinn
Copy link
Member

rofinn commented Mar 17, 2021 •
edited
Loading

We currently have a big jump from the docstring examples in the API docs and the one very large example that assumes you're already familiar with the API. This documentation structure results in a lot of cognitive load when learning the package, particularly since it pulls in syntax from half a dozen other packages (e.g., Tables, DataFrames, AxisKeys)
@rofinn rofinn added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Mar 17, 2021
@rofinn
Copy link
Member Author

rofinn commented Mar 29, 2021

I'm also wondering if a diagram like this would help folks visualize what's happening.

KeyedDataset

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rofinn