Skip to content

Commit

Permalink
Merge pull request #255 from hx2A/fix201
Browse files Browse the repository at this point in the history
update docs to fix #201
  • Loading branch information
hx2A authored Mar 10, 2023
2 parents c28f4bf + 71a2672 commit 738764d
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions py5_docs/Reference/api_en/Sketch_run_sketch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ sketch_functions: dict[str, Callable] = None - sketch methods when using module
@@ description
Run the Sketch. Code in the `settings()`, `setup()`, and `draw()` functions will be used to actualize your Sketch.

Use the `block` parameter to specify if the call to `run_sketch()` should return immediately (asynchronous Sketch execution) or block until the Sketch exits. If the `block` parameter is not specified, py5 will first attempt to determine if the Sketch is running in a Jupyter Notebook or an IPython shell. If it is, `block` will default to `False`, and `True` otherwise.

Blocking is not supported on OSX. This is because of the (current) limitations of py5 on OSX. If the `block` parameter is set to `True`, a warning message will appear and it will be changed to `False`.
Use the `block` parameter to specify if the call to `run_sketch()` should return immediately (asynchronous Sketch execution) or block until the Sketch exits. If the `block` parameter is not specified, py5 will first attempt to determine if the Sketch is running in a Jupyter Notebook or an IPython shell. If it is, `block` will default to `False`, and `True` otherwise. However, on OSX, these default values are required, as py5 cannot work on OSX without it.

A list of strings passed to `py5_options` will be passed to the Processing PApplet class as arguments to specify characteristics such as the window's location on the screen. A list of strings passed to `sketch_args` will be available to a running Sketch using [](sketch_pargs). See the third example for an example of how this can be used.

Expand Down

0 comments on commit 738764d

Please sign in to comment.