Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - Fix a bunch of typos, and improve certain parts of the documentation #2437

Merged
merged 7 commits into from
Oct 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/get_started/arcade_book.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
12 changes: 6 additions & 6 deletions doc/get_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/programming_guide/gui/own_layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions doc/programming_guide/gui/own_widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions doc/programming_guide/opengl_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 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`.
Expand Down
2 changes: 1 addition & 1 deletion doc/programming_guide/sprites/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading