chrisjsewell/ipypublish

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

Opened this issue · 1 comments

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.

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