Skip to content

Fix GUI example docstrings #1758

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

Merged
merged 16 commits into from
May 7, 2023

Conversation

pushfoo
Copy link
Member

@pushfoo pushfoo commented May 7, 2023

Changes

Follow-up to #1750, prepares for further improvements to example docstring tests.

  • Rename one of the GUI example files
  • Add or correct top-level docstrings in GUI examples for clarity
  • Ensure all docstrings include an example run command per project standards

How to test

I know the instructions below are a pain. This PR is a step toward fixing the problem.

Locally retarget test_example_docstrings.py by making the following changes:

  1. add imnport arcade.gui at the top
  2. set `EXAMPLE_ROOT = "arcade.gui.examples"
  3. In test_docstrings, replace arcade.examples.__path__[0] with arcade.gui.examples.__path__[0]
  4. (Optional) if using PyCharm, make sure the run configuration for this test sets the working directory to the project root
  5. Run the test, either through the GUI or with pytest tests/unit/test_example_docstrings.py

@pvcraven pvcraven merged commit 2863170 into pythonarcade:development May 7, 2023
@pushfoo pushfoo deleted the fix_gui_example_docstrings branch May 7, 2023 04:26
@eruvanos
Copy link
Member

eruvanos commented May 8, 2023

Great work, thanks!

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.

3 participants