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

In the docs, show the meta data with the code snippets? #117

Open
bdatko opened this issue Nov 24, 2019 · 1 comment
Open

In the docs, show the meta data with the code snippets? #117

bdatko opened this issue Nov 24, 2019 · 1 comment

Comments

@bdatko
Copy link

bdatko commented Nov 24, 2019

When I was playing around with reproducing the figures shown in the docs, it took me an embarrassing amount of time to realize how the metadata inside the cell was vital to controlling the output.

A clearer example to reproduce the code snippets seen in the docs might be show the code with the corresponding metadata.

Paring the code with the metadata might also help with explaining the workflow. When I first stumbled onto the package I was a little loss with putting everything together. The Getting Started page does have an Important tag related to this concern. But it's so far down the page, and it took me reading a majority of the docs to realize the significance.

@chrisjsewell
Copy link
Owner

Thanks for the feedback @bdatko 👍 these definitely sound like reasonable improvements

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

No branches or pull requests

2 participants