Skip to content

Improve docstrings related to mouse events on arcade.Window#1235

Merged
pvcraven merged 1 commit intopythonarcade:developmentfrom
pushfoo:improve_window_mouse_doc
Jun 7, 2022
Merged

Improve docstrings related to mouse events on arcade.Window#1235
pvcraven merged 1 commit intopythonarcade:developmentfrom
pushfoo:improve_window_mouse_doc

Conversation

@pushfoo
Copy link
Member

@pushfoo pushfoo commented Jun 7, 2022

If these changes look good, I can expand them to View and other classes that implement the same functions as Window.

Changes made:

  • Clarify and elaborate on docstrings for set_mouse_visible
  • Clarify set_mouse_platform_visible docstring and link pyglet doc
  • Clarify time-related wording on_mouse_* event docstrings
  • Correct mention of pixel units in on_mouse_scroll docstring
  • Add warnings and suggestions for certain functions

* Clarify and elaborate docstrings for set_mouse_visible

* Reformat set_mouse_platform_visible docstring and link pyglet doc

* Clarify time-related wording on_mouse_* event docstrings

* Correct mention of pixel units in on_mouse_scroll docstring

* Add warnings and suggestions for certain functions
@pvcraven pvcraven merged commit bf77206 into pythonarcade:development Jun 7, 2022
@pvcraven
Copy link
Member

pvcraven commented Jun 7, 2022

Thanks!

@pushfoo pushfoo deleted the improve_window_mouse_doc branch June 18, 2022 10:39
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