Add recipe for file output and side effects #55
Conversation
docs/user-guide/recipes.ipynb
Outdated
| "from typing import NewType\n", | ||
| "\n", | ||
| "import sciline" |
There was a problem hiding this comment.
If you imagine adding more recipes, we should make each stand-alone, i.e., move imports into the concrete example.
There was a problem hiding this comment.
I figured that these two are needed everywhere. But I can change it.
There was a problem hiding this comment.
Yes, but it makes it easier to copy-and-paste a working example if we repeat it. Or to split the page later.
docs/user-guide/recipes.ipynb
Outdated
| "id": "d7608bb4-d7ce-4a36-8021-f1a52ad27ec5", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# Recipes" |
There was a problem hiding this comment.
Should this be a sibling of User Guide, so it can be reached more easily in fewer clicks?
There was a problem hiding this comment.
Can be. We have limited real estate in the top bar. Do you think this is important / commonly used enough?
|
What do you think of the name 'Recipes'? What about 'Examples', 'How to', or something similar. This is the best time to change it... |
Recipes is good. Or "Recipes and Examples"? How to sounds good as well :) |
|
I left it as recipes because that is short and the header is short, too. |
Fixes #29