explaining sketch().run() #56
Conversation
There was a problem hiding this comment.
Thanks @tpltnt !
The developer reference is intended to be for developers working on the nannou code-base itself. Perhaps this addition would be better suited under Updating nannou section?
src/developer_reference.md
Outdated
| Sometimes you have to touch old code and make it work in a new environment. | ||
| This sections helps you deal with problems you might encounter. | ||
|
|
||
| In general it helps to read all the CHANGELOG files from your (old) source |
There was a problem hiding this comment.
No need for brackets here
src/developer_reference.md
Outdated
| version to the target you want to upgrade to. | ||
|
|
||
|
|
||
| ## Sketches don't run |
There was a problem hiding this comment.
Perhaps we should put the "Sketches don't run" and "with_dimension is gone" under a "Version 0.13 Changes" heading? It might help to clarify in the future that these changes are specific to version 0.13 e.g.
## Version 0.13 Changes
### Sketches don't run
...
## Window sizing does not work / with_dimension is gone
...
There was a problem hiding this comment.
Right now they are specific to 0.13, but I advise against it. Later people are going to look for their problems (in the headings) and not for version changes.
There was a problem hiding this comment.
I think the version number can be useful for checking which changes occurred during the period of time since the user updated their code. The sub-headings can still be there.
src/developer_reference.md
Outdated
| nannou::sketch(view).size(width, height).run() | ||
| ``` | ||
|
|
||
| This required changing the `sketch()` function to return a builder type rather than running immediately (as done in the past). |
src/developer_reference.md
Outdated
| ``` | ||
|
|
||
| This required changing the `sketch()` function to return a builder type rather than running immediately (as done in the past). | ||
| Specifying the size of a window in the view function felt awkward (and caused a panic on Windows after a winit update). |
|
As mentioned in my last comment, is it possible to move this to the existing Updating nannou section? I don't think we need a whole chapter for this. In general, this sort of information is what the CHANGELOG is intended to provide. Perhaps instead of adding this section, we can move the CHANGELOG into the guide? I might do this as a part of nannou-org/nannou#449. |
|
I missed the part about moving the text. I adjusted everything accordingly. |
Hi there,
I added a small section on updating code to the guide. I did run into the sketch().run() thing and so I documented the solution in the guide. (Since the github issue feels like a temporary hack to me).
Cheers,
tpltnt