Merge pull request #392 from hx2A/renameosx

rename osx -> macOS

Author: hx2A

README.md

@@ -46,7 +46,7 @@ If you have Java 17 installed on your computer, you can install py5 using pip:
 pip install py5
 ```
 
-[Detailed installation instructions](https://py5coding.org/content/install.html) are available on the documentation website. There are some [Special Notes for Mac Users](https://py5coding.org/content/osx_users.html) that you should read if you use OSX.
+[Detailed installation instructions](https://py5coding.org/content/install.html) are available on the documentation website. There are some [Special Notes for Mac Users](https://py5coding.org/content/osx_users.html) that you should read if you use macOS.
 
 ## Getting Started
 

py5_docs/Reference/api_en/Py5Functions_render.txt

@@ -18,7 +18,7 @@ Decorator function to render a single frame using the decorated `draw` function.
 
 The decorated draw function's first parameter must be either a `py5.Sketch` object or a `py5.Py5Graphics` object, depending on the parameter `use_py5graphics`. That object must be used for all of the function's py5 commands. The function can have additional positional and keyword arguments. To use them, pass the desired values when you call the decorated function as you would to any other Python function.
 
-On OSX, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
+On macOS, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
 
 The rendered frame can have transparent pixels if and only if the `use_py5graphics` parameter is `True` because only a `py5.Py5Graphics` object can create an image with transparency. There is no need to call [](py5graphics_begin_draw) or [](py5graphics_end_draw) in the decorated function as `@render()` does that for you.
 

py5_docs/Reference/api_en/Py5Functions_render_frame.txt

@@ -21,7 +21,7 @@ Helper function to render a single frame using the passed `draw` function argume
 
 The passed function's first parameter must be either a `py5.Sketch` object or a `py5.Py5Graphics` object, depending on the parameter `use_py5graphics`. That object must be used for all of the function's py5 commands. The function can have additional positional and keyword arguments. To use them, pass the desired values as `render_frame`'s `draw_args` and `draw_kwargs` arguments.
 
-On OSX, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
+On macOS, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
 
 The rendered frame can have transparent pixels if and only if the `use_py5graphics` parameter is `True` because only a `py5.Py5Graphics` object can create an image with transparency. There is no need to call [](py5graphics_begin_draw) or [](py5graphics_end_draw) in the passed function as `render_frame()` does that for you.
 

py5_docs/Reference/api_en/Py5Functions_render_frame_sequence.txt

@@ -25,7 +25,7 @@ Helper function to render a sequence of frames using the passed `draw` function
 
 The passed `draw` function's first parameter must be either a `py5.Sketch` object or a `py5.Py5Graphics` object, depending on the parameter `use_py5graphics`. That object must be used for all py5 commands. The function can have additional positional and keyword arguments. To use them, pass the desired values to `render_frame_sequence`'s `draw_args` and `draw_kwargs` arguments.
 
-On OSX, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
+On macOS, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
 
 The rendered frames can have transparent pixels if and only if the `use_py5graphics` parameter is `True` because only a `py5.Py5Graphics` object can create an image with transparency. If you need to clear the canvas between one frame and the next, use [](py5graphics_clear). There is no need to call [](py5graphics_begin_draw) or [](py5graphics_end_draw) in the passed `draw` function as `render_frame_sequence()` does that for you.
 

py5_docs/Reference/api_en/Py5Functions_render_sequence.txt

@@ -24,7 +24,7 @@ The decorated function's first parameter must be either a `py5.Sketch` object or
 
 Optionally, the caller can pass the decorator a `setup` function, along with corresponding `setup_args` and `setup_kwargs` arguments. This will be called once, just like it would for any other py5 Sketch. The type of the first parameter must also depend on the `use_py5graphics` parameter.
 
-On OSX, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
+On macOS, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
 
 The rendered frames can have transparent pixels if and only if the `use_py5graphics` parameter is `True` because only a `py5.Py5Graphics` object can create an image with transparency. If you need to clear the canvas between one frame and the next, use [](py5graphics_clear). There is no need to call [](py5graphics_begin_draw) or [](py5graphics_end_draw) in the decorated function as `@render_sequence()` does that for you.
 

py5_docs/Reference/api_en/Py5Graphics_pixel_height.txt

@@ -7,6 +7,6 @@ pclass = PGraphics
 processing_name = pixelHeight
 
 @@ description
-Height of the Py5Graphics drawing surface in pixels. When `pixel_density(2)` was used in `settings()` to make use of a high resolution display (called a Retina display on OSX or high-dpi on Windows and Linux), the width and height of the Py5Graphics drawing surface does not change, but the number of pixels is doubled. As a result, all operations that use pixels (like [](py5graphics_load_pixels), [](py5graphics_get_pixels), etc.) happen in this doubled space. As a convenience, the variables [](py5graphics_pixel_width) and `pixel_height` hold the actual width and height of the drawing surface in pixels. This is useful for any Py5Graphics objects that use the [](py5graphics_pixels) or [](py5graphics_np_pixels) arrays, for instance, because the number of elements in each array will be `pixel_width*pixel_height`, not `width*height`.
+Height of the Py5Graphics drawing surface in pixels. When `pixel_density(2)` was used in `settings()` to make use of a high resolution display (called a Retina display on macOS or high-dpi on Windows and Linux), the width and height of the Py5Graphics drawing surface does not change, but the number of pixels is doubled. As a result, all operations that use pixels (like [](py5graphics_load_pixels), [](py5graphics_get_pixels), etc.) happen in this doubled space. As a convenience, the variables [](py5graphics_pixel_width) and `pixel_height` hold the actual width and height of the drawing surface in pixels. This is useful for any Py5Graphics objects that use the [](py5graphics_pixels) or [](py5graphics_np_pixels) arrays, for instance, because the number of elements in each array will be `pixel_width*pixel_height`, not `width*height`.
 
 This field is the same as [](sketch_pixel_height) but linked to a `Py5Graphics` object. To see example code for how it can be used, see [](sketch_pixel_height).

py5_docs/Reference/api_en/Py5Graphics_pixel_width.txt

@@ -7,6 +7,6 @@ pclass = PGraphics
 processing_name = pixelWidth
 
 @@ description
-Width of the Py5Graphics drawing surface in pixels. When `pixel_density(2)` was used in `settings()` to make use of a high resolution display (called a Retina display on OSX or high-dpi on Windows and Linux), the width and height of the Py5Graphics drawing surface does not change, but the number of pixels is doubled. As a result, all operations that use pixels (like [](py5graphics_load_pixels), [](py5graphics_get_pixels), etc.) happen in this doubled space. As a convenience, the variables `pixel_width` and [](py5graphics_pixel_height) hold the actual width and height of the drawing surface in pixels. This is useful for any Py5Graphics objects that use the [](py5graphics_pixels) or [](py5graphics_np_pixels) arrays, for instance, because the number of elements in each array will be `pixel_width*pixel_height`, not `width*height`.
+Width of the Py5Graphics drawing surface in pixels. When `pixel_density(2)` was used in `settings()` to make use of a high resolution display (called a Retina display on macOS or high-dpi on Windows and Linux), the width and height of the Py5Graphics drawing surface does not change, but the number of pixels is doubled. As a result, all operations that use pixels (like [](py5graphics_load_pixels), [](py5graphics_get_pixels), etc.) happen in this doubled space. As a convenience, the variables `pixel_width` and [](py5graphics_pixel_height) hold the actual width and height of the drawing surface in pixels. This is useful for any Py5Graphics objects that use the [](py5graphics_pixels) or [](py5graphics_np_pixels) arrays, for instance, because the number of elements in each array will be `pixel_width*pixel_height`, not `width*height`.
 
 This field is the same as [](sketch_pixel_width) but linked to a `Py5Graphics` object. To see example code for how it can be used, see [](sketch_pixel_width).

py5_docs/Reference/api_en/Py5Magics_py5bot.txt

@@ -18,7 +18,7 @@ This cell magic uses the same rendering mechanism as the py5bot kernel. For user
 
 This magic is similar to [](py5magics_py5draw) in that both can be used to create a static Sketch. One key difference is that `%%py5bot` requires the user to begin the code with a call to [](sketch_size), while [](py5magics_py5draw) calls [](sketch_size) for you based on the magic's arguments. 
 
-This magic supports the default renderer and the `P2D` and `P3D` renderers. Note that both of the OpenGL renderers will briefly open a window on your screen. This magic is only available when using the py5 kernel and coding in imported mode. The `P2D` and `P3D` renderers are not available when the py5 kernel is hosted on an OSX computer.
+This magic supports the default renderer and the `P2D` and `P3D` renderers. Note that both of the OpenGL renderers will briefly open a window on your screen. This magic is only available when using the py5 kernel and coding in imported mode. The `P2D` and `P3D` renderers are not available when the py5 kernel is hosted on an macOS computer.
 
 Code used in this cell can reference functions and variables defined in other cells because a copy of the user namespace is provided during execution. Variables and functions created in this cell will be local to only this cell because to do otherwise would be unsafe. Mutable objects in the user namespace, however, can be altered and those changes will persist elsewhere in the notebook. Be aware that using py5 objects in a different notebook cell or reusing them in another Sketch can result in nasty errors and bizzare consequences.
 

py5_docs/Reference/api_en/Py5Magics_py5draw.txt

@@ -28,7 +28,7 @@ Create a PNG image with py5 and embed the result in the notebook.
 
 For users who are familiar with Processing and py5 programming, you can pretend the code in this cell will be executed in a Sketch with no `draw()` function and your code in the `setup()` function. By default it will use the default Processing renderer.
 
-On OSX, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
+On macOS, only the default renderer is currently supported. Other platforms support the default renderer and the OpenGL renderers (P2D and P3D).
 
 Internally this magic command creates a static Sketch using the user provided code. The static Sketch drawing surface does not allow transparency. If you want to quickly create an image that has transparency, consider using [](py5functions_render) or [](py5functions_render_frame) with the `use_py5graphics` parameter.
 

py5_docs/Reference/api_en/Py5Magics_py5drawdxf.txt

@@ -24,7 +24,7 @@ For users who are familiar with Processing and py5 programming, you can pretend
 
 As this is creating a DXF file, your code will be limited to the capabilities of that renderer. 
 
-This magic is not available on OSX.
+This magic is not available on macOS.
 
 Code used in this cell can reference functions and variables defined in other cells because a copy of the user namespace is provided during execution. By default, variables and functions created in this cell will be local to only this cell because to do otherwise would be unsafe. Mutable objects in the user namespace, however, can be altered and those changes will persist elsewhere in the notebook.
 

py5_docs/Reference/api_en/Py5Tools_animated_gif.txt

@@ -26,7 +26,7 @@ You have two choices for how to specify which frames should be included in the a
 
 Bottom line, you must use either the `count` parameter or the `frame_numbers` parameter but not both. The `period` parameter can only be used in conjunction with the `count` parameter. The duration parameter must always be used.
 
-By default this function will return right away and construct the animated gif in the background while the Sketch is running. The completed gif will be saved to the location specified by the `filename` parameter when it is ready. Set the `block` parameter to `True` to instruct the function to not return until the gif construction is complete. This blocking feature is not available on OSX when the Sketch is executed through an IPython kernel. If the Sketch terminates prematurely, no gif will be created.
+By default this function will return right away and construct the animated gif in the background while the Sketch is running. The completed gif will be saved to the location specified by the `filename` parameter when it is ready. Set the `block` parameter to `True` to instruct the function to not return until the gif construction is complete. This blocking feature is not available on macOS when the Sketch is executed through an IPython kernel. If the Sketch terminates prematurely, no gif will be created.
 
 By default the Sketch will be the currently running Sketch, as returned by [](py5functions_get_current_sketch). Use the `sketch` parameter to specify a different running Sketch, such as a Sketch created using Class mode.
 

py5_docs/Reference/api_en/Py5Tools_offline_frame_processing.txt

@@ -28,7 +28,7 @@ Use the `limit` parameter to stop frame processing after a set number of frames.
 
 The `queue_limit` parameter specifies a maximum queue size. If frames are added to the queue faster than they can be processed, the queue size will grow unbounded. Setting a queue limit will cause the oldest frames on the queue to be dropped, one batch at a time. You can use the `period` parameter to pause between frames that are collected for processing, throttling the workload.
 
-By default this function will return right away and will process frames in the background while the Sketch is running. Set the `block` parameter to `True` to instruct the method to not return until the processing is complete or the Sketch terminates. This blocking feature is not available on OSX when the Sketch is executed through an IPython kernel.
+By default this function will return right away and will process frames in the background while the Sketch is running. Set the `block` parameter to `True` to instruct the method to not return until the processing is complete or the Sketch terminates. This blocking feature is not available on macOS when the Sketch is executed through an IPython kernel.
 
 Use the `sketch` parameter to specify a different running Sketch, such as a Sketch created using Class mode. If your Sketch has a `post_draw()` method, use the `hook_post_draw` parameter to make this function run after `post_draw()` instead of `draw()`. This is important when using Processing libraries that support `post_draw()` such as Camera3D or ColorBlindness.
 

py5_docs/Reference/api_en/Py5Tools_save_frames.txt

@@ -21,7 +21,7 @@ start: int = None - frame starting number instead of Sketch frame_count
 @@ description
 Save a running Sketch's frames to a directory.
 
-By default this function will return right away and save frames in the background while the Sketch is running. The frames will be saved in the directory specified by the `dirname` parameter. Set the `block` parameter to `True` to instruct the method to not return until the number of frames saved reaches the number specified by the `limit` parameter. This blocking feature is not available on OSX when the Sketch is executed through an IPython kernel.
+By default this function will return right away and save frames in the background while the Sketch is running. The frames will be saved in the directory specified by the `dirname` parameter. Set the `block` parameter to `True` to instruct the method to not return until the number of frames saved reaches the number specified by the `limit` parameter. This blocking feature is not available on macOS when the Sketch is executed through an IPython kernel.
 
 By default the Sketch will be the currently running Sketch, as returned by [](py5functions_get_current_sketch). Use the `sketch` parameter to specify a different running Sketch, such as a Sketch created using Class mode.
 

py5_docs/Reference/api_en/Sketch_display_density.txt

@@ -14,7 +14,7 @@ display_density(display: int, /) -> int
 display: int - the display number to check (1-indexed to match the Preferences dialog box)
 
 @@ description
-This function returns the number "2" if the screen is a high-density screen (called a Retina display on OSX or high-dpi on Windows and Linux) and a "1" if not. This information is useful for a program to adapt to run at double the pixel density on a screen that supports it.
+This function returns the number "2" if the screen is a high-density screen (called a Retina display on macOS or high-dpi on Windows and Linux) and a "1" if not. This information is useful for a program to adapt to run at double the pixel density on a screen that supports it.
 
 @@ example
 def setup():

py5_docs/Reference/api_en/Sketch_pixel_height.txt

@@ -7,7 +7,7 @@ pclass = PApplet
 processing_name = pixelHeight
 
 @@ description
-Height of the display window in pixels. When `pixel_density(2)` is used to make use of a high resolution display (called a Retina display on OSX or high-dpi on Windows and Linux), the width and height of the Sketch do not change, but the number of pixels is doubled. As a result, all operations that use pixels (like [](sketch_load_pixels), [](sketch_get_pixels), etc.) happen in this doubled space. As a convenience, the variables [](sketch_pixel_width) and `pixel_height` hold the actual width and height of the Sketch in pixels. This is useful for any Sketch that use the [](sketch_pixels) or [](sketch_np_pixels) arrays, for instance, because the number of elements in each array will be `pixel_width*pixel_height`, not `width*height`.
+Height of the display window in pixels. When `pixel_density(2)` is used to make use of a high resolution display (called a Retina display on macOS or high-dpi on Windows and Linux), the width and height of the Sketch do not change, but the number of pixels is doubled. As a result, all operations that use pixels (like [](sketch_load_pixels), [](sketch_get_pixels), etc.) happen in this doubled space. As a convenience, the variables [](sketch_pixel_width) and `pixel_height` hold the actual width and height of the Sketch in pixels. This is useful for any Sketch that use the [](sketch_pixels) or [](sketch_np_pixels) arrays, for instance, because the number of elements in each array will be `pixel_width*pixel_height`, not `width*height`.
 
 @@ example
 def setup():