Skip to content

Commit a8ced82

Browse files
authored
Fix typos and change phrasing for academia (#2565)
* Style fix: s/Python Arcade/Arcade/ in body text * Typo, phrasing, and style fixes on the For Educators & Researchers page * Fix typo * Improve phrasing * Cross-ref with PyPI link
1 parent 4d66523 commit a8ced82

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

doc/about/for_academia.rst

+19-18
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ For Educators & Researchers
55

66
.. _citation template: https://github.com/pythonarcade/arcade#citation
77

8-
Python Arcade was created by Paul V. Craven while teaching at Simpson College.
8+
Arcade was created by Paul V. Craven while teaching at Simpson College.
99

1010
In addition to the main Arcade 3.0 documentation you are currently reading, there
1111
are further resources to help academic users. These include:
@@ -32,37 +32,39 @@ To learn more about using this template, please consult the following:
3232

3333
Version Considerations
3434
----------------------
35-
Most users will be better off using Arade 3.0.
35+
Most users will be best served by `Arcade's latest release from PyPI <PyPI>`_
3636

37-
The main case for continuing to use ``2.6.X`` releases is reliance on teaching
38-
materials which have not yet been updated, including the :ref:`academia_arcade_book`.
37+
For new games, the features and improved efficiency of Arcade 3 make it the
38+
best choice. Upgrading existing games is also worthwhile.
3939

40+
The main case for using ``2.6.X`` releases is when you must use teaching
41+
materials which lack an updated version for Arcade 3.0+. This includes the
42+
companion :ref:`academia_arcade_book` covered in depth below.
4043

41-
.. _academia_arcade_book:
4244

43-
Arcade Book
44-
^^^^^^^^^^^
45+
.. _academia_arcade_book:
4546

46-
The creator of Arcade wrote an `Arcade book`_ which covers Python basics in greater depth
47-
than the main Arcade documentation.
47+
Arcade Textbook
48+
^^^^^^^^^^^^^^^
4849

50+
The creator of Arcade wrote an `Arcade Textbook <Arcade book>`_ which covers Python basics
51+
n greater depth than the main Arcade documentation.
4952

50-
It may be some time until the `Arcade book`_ is updated for Arcade 3.0. Doing so requires a
51-
separate effort after the 3.0 release due to the the scale and number of changes since
52-
Arcade 2.6.
53+
It may be a while before the `Arcade Textbook <Arcade book>`_ is updated for Arcade 3.0. This
54+
is a large undertaking due to the number and scale of changes since Arcade 2.6.
5355

5456

55-
Similarities to this Documentation
56-
""""""""""""""""""""""""""""""""""
57+
Similarities
58+
""""""""""""
5759

58-
Both the book and the documentation you are currently reading provide:
60+
Both the textbook and the documentation you are currently reading provide:
5961

6062
* all-ages learning resources
6163
* gentle introductions to Python and Arcade
6264

6365

64-
Differences from this Documentation
65-
"""""""""""""""""""""""""""""""""""
66+
Differences
67+
"""""""""""
6668

6769
The book caters more heavily to beginners and educators by providing the following
6870
in a traditional chapter and curriculum structure:
@@ -141,7 +143,6 @@ SBCs based on RISC-V CPUs are likely to lack:
141143
* beginner-friendly documentation
142144

143145

144-
145146
Credit Card Rule
146147
""""""""""""""""
147148

0 commit comments

Comments
 (0)