From 1c3d6b308861a54762e698b15205cdfa08c984db Mon Sep 17 00:00:00 2001 From: csd4ni3l <96988024+csd4ni3l@users.noreply.github.com> Date: Sun, 27 Oct 2024 12:20:12 +0100 Subject: [PATCH 1/7] Fix typos and tense in opengl_notes.rst --- doc/programming_guide/opengl_notes.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/programming_guide/opengl_notes.rst b/doc/programming_guide/opengl_notes.rst index 917221cea..bd760e2a0 100644 --- a/doc/programming_guide/opengl_notes.rst +++ b/doc/programming_guide/opengl_notes.rst @@ -3,9 +3,9 @@ OpenGL ====== -Arcade is using OpenGL for the underlying rendering. OpenGL -functionality is given to use through pyglet when a window -is crated. The underlying representation of this is an +Arcade uses OpenGL for the underlying rendering, and OpenGL +functionality is used through pyglet when a window +is cre ated. The underlying representation of this is an OpenGL context. Arcade's representation of this context is the :py:attr:`arcade.Window.ctx`. This is an :py:class:`~arcade.ArcadeContext`. From 122995b0a30b554f9a8cfa2f401d757459caac39 Mon Sep 17 00:00:00 2001 From: csd4ni3l <96988024+csd4ni3l@users.noreply.github.com> Date: Sun, 27 Oct 2024 12:28:19 +0100 Subject: [PATCH 2/7] Fix a typo and rephrase in opengl_notes.rst --- doc/programming_guide/opengl_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/programming_guide/opengl_notes.rst b/doc/programming_guide/opengl_notes.rst index bd760e2a0..6e45987a4 100644 --- a/doc/programming_guide/opengl_notes.rst +++ b/doc/programming_guide/opengl_notes.rst @@ -5,7 +5,7 @@ OpenGL Arcade uses OpenGL for the underlying rendering, and OpenGL functionality is used through pyglet when a window -is cre ated. The underlying representation of this is an +is created. The underlying representation of this is an OpenGL context. Arcade's representation of this context is the :py:attr:`arcade.Window.ctx`. This is an :py:class:`~arcade.ArcadeContext`. From c291106e93b3b382ba818b50aa3d4a2fea1e9575 Mon Sep 17 00:00:00 2001 From: csd4ni3l <96988024+csd4ni3l@users.noreply.github.com> Date: Sun, 27 Oct 2024 12:32:42 +0100 Subject: [PATCH 3/7] Rephrase OpenGL requirements in arcade_book.rst --- doc/get_started/arcade_book.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/get_started/arcade_book.rst b/doc/get_started/arcade_book.rst index c9c3609c1..87130a0db 100644 --- a/doc/get_started/arcade_book.rst +++ b/doc/get_started/arcade_book.rst @@ -10,7 +10,7 @@ The Arcade Book Installation ------------ Arcade can be installed like any other Python -Package. Arcade needs support for OpenGL 3.3+. +Package. Your machine(s) need to support OpenGL 3.3+ for arcade to work. If you are familiar with Python package management you can just "pip install" Arcade. For more detailed instructions see :ref:`install`. From 817682aac07508be8b8df1db251344144bf5c6b1 Mon Sep 17 00:00:00 2001 From: csd4ni3l <96988024+csd4ni3l@users.noreply.github.com> Date: Sun, 27 Oct 2024 12:37:07 +0100 Subject: [PATCH 4/7] Rephrase and fix typos in install.rst --- doc/get_started/install.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/get_started/install.rst b/doc/get_started/install.rst index 2cd60e460..f3eaf3da9 100644 --- a/doc/get_started/install.rst +++ b/doc/get_started/install.rst @@ -11,25 +11,25 @@ Using pip .. Tip:: - For beginners unfamiliar with python a more in depth guide to + For beginners unfamiliar with Python, a more in depth guide to installing Python and Arcade can be found in the :ref:`arcade_book`. -The most common way to install Arcade is to use ``pip``. +The most common way to install Arcade is to use the ``pip`` package manager. This will install the latest version of Arcade from `PyPI`_. .. code-block:: bash pip install arcade -If you are installing Arcade directly into your system python meaning -you are not using a virtual environment (or don't know that that is) +If you are installing Arcade directly into your system Python, meaning +you are not using a virtual environment (or don't know what that is), you may need to use the ``--user`` flag to install Arcade just for your user. .. code-block:: bash pip install arcade --user -Upgrading an existing installation of Arcade can be done with the following command +Upgrading an existing installation of Arcade can be done with the following command: .. code-block:: bash @@ -49,7 +49,7 @@ If you prefer to install from git:: cd arcade pip install -e . -This installs Arcade in editable mode so you can make changes to the code and see the changes immediately. +This installs Arcade in editable mode, so you can make changes to the code and see the changes immediately. Also consider forking the repository on github installing your fork instead. Running examples From e6c541a8fce27d224bbeac080f89efb5d76748f5 Mon Sep 17 00:00:00 2001 From: csd4ni3l <96988024+csd4ni3l@users.noreply.github.com> Date: Sun, 27 Oct 2024 12:39:18 +0100 Subject: [PATCH 5/7] Add "your" prefixes to "own layout" in own_layout.rst --- doc/programming_guide/gui/own_layout.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/programming_guide/gui/own_layout.rst b/doc/programming_guide/gui/own_layout.rst index e63ca7495..d054264c6 100644 --- a/doc/programming_guide/gui/own_layout.rst +++ b/doc/programming_guide/gui/own_layout.rst @@ -3,7 +3,7 @@ Own Layout ---------- -Creating own layouts is the master class of creating own widgets. +Creating your own layouts is the master class of creating own widgets. It allows you to create custom layouts that can be used in your application to position widgets. General use cases for own layouts are: @@ -14,7 +14,7 @@ General use cases for own layouts are: Where to start ~~~~~~~~~~~~~~ -To create own layout, you need to create a new class that inherits from :class:`arcade.gui.UILayout`. +To create your own layout, you need to create a new class that inherits from :class:`arcade.gui.UILayout`. The main method you need to implement is: From 89a0da4381ce761ab9739a1d0ffb1e43a1666115 Mon Sep 17 00:00:00 2001 From: csd4ni3l <96988024+csd4ni3l@users.noreply.github.com> Date: Sun, 27 Oct 2024 12:39:57 +0100 Subject: [PATCH 6/7] Add "your" prefix to "own widgets" in own_widgets.rst --- doc/programming_guide/gui/own_widgets.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/programming_guide/gui/own_widgets.rst b/doc/programming_guide/gui/own_widgets.rst index b12974f12..495ab79fc 100644 --- a/doc/programming_guide/gui/own_widgets.rst +++ b/doc/programming_guide/gui/own_widgets.rst @@ -3,7 +3,7 @@ Own Widgets ----------- -Creating own widgets is a powerful feature of the GUI module. +Creating your own widgets is a powerful feature of the GUI module. It allows you to create custom widgets that can be used in your application. In most cases this is even the easiest way to implement your desired interface. @@ -15,7 +15,7 @@ The following sections will guide you through the process of creating own widget Where to start ~~~~~~~~~~~~~~ -To create own widgets, you need to create a new class that inherits from :class:`arcade.gui.UIWidget`. +To create your own widgets, you need to create a new class that inherits from :class:`arcade.gui.UIWidget`. While inheriting from :class:`arcade.gui.UIWidget`, provides the highest flexibility. The main methods you need to implement are: From 82c787fe939cca5f1a80f4ba9303742d838bd4e9 Mon Sep 17 00:00:00 2001 From: csd4ni3l <96988024+csd4ni3l@users.noreply.github.com> Date: Sun, 27 Oct 2024 12:42:03 +0100 Subject: [PATCH 7/7] Fix typo in sprites/advanced.rst --- doc/programming_guide/sprites/advanced.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/programming_guide/sprites/advanced.rst b/doc/programming_guide/sprites/advanced.rst index 87eefaa87..6f3e58573 100644 --- a/doc/programming_guide/sprites/advanced.rst +++ b/doc/programming_guide/sprites/advanced.rst @@ -45,7 +45,7 @@ see the following: Sorting SpriteLists """"""""""""""""""" -Although the alternative listed above are often better, sorting sprite lists to +Although the alternatives listed above are often better, sorting sprite lists to control draw order can still be useful. Like Python's built-in :py:meth:`list.sort`, you can pass a