Skip to content

Improve keyboard modifier & event doc#1242

Merged
einarf merged 1 commit intopythonarcade:developmentfrom
pushfoo:improve_keyboard_event_doc
Jun 20, 2022
Merged

Improve keyboard modifier & event doc#1242
einarf merged 1 commit intopythonarcade:developmentfrom
pushfoo:improve_keyboard_event_doc

Conversation

@pushfoo
Copy link
Member

@pushfoo pushfoo commented Jun 18, 2022

This is a follow-up to pyglet/pyglet#629. Prior to this PR, our keyboard modifier doc was a copy of the pyglet's. I significantly expanded it to hold the reader's hand because middle and highschool students are one of our target demographics.

Built & tested locally.

Summary of changes:

  • Rewrite Working with the Keyboard to include concept of active modifiers
  • Fix misleading keyboard modifier phrasing in application.py to use active instead of held
  • Make keyboard event doc consistent with mouse event doc in Window
  • Add links to examples of handling keyboard events to Working with the Keyboard
  • Add links to doc for arcade.key module containing constants
  • Fix some awkward phrasing in open_window docstring

* Rewrite Working with the Keyboard to include concept of active modifiers

* Fix misleading keyboard modifier phrasing in application.py to use active instead of held

* Make keyboard event doc consistent with mouse event doc in Window

* Add links to examples of handling keyboard events to Working with the Keyboard

* Add links to doc for arcade.key module containing constants

* Fix some awkward phrasing in open_window docstring
@pushfoo pushfoo force-pushed the improve_keyboard_event_doc branch from 08d13a6 to c973ae8 Compare June 18, 2022 21:10
@pushfoo pushfoo changed the title Improve keyboard event doc to fix subtle errors Improve keyboard modifier & event doc Jun 18, 2022
@einarf einarf merged commit 7a58ba7 into pythonarcade:development Jun 20, 2022
@pushfoo pushfoo deleted the improve_keyboard_event_doc branch August 1, 2022 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants