search

pythonarcade / arcade

Easy to use Python library for creating 2D arcade games.
http://arcade.academy
Other
1.69k stars 319 forks source link

Improve beginner friendliness of output from ./make.py format #2165

Open pushfoo opened 3 months ago

pushfoo commented 3 months ago

Enhancement

CI formatting output could be clearer for beginners.

Actual behavior:

image

Expected behavior:

Useful debug output

Steps to reproduce/example code:

PR something or run ./make.py format --check

Cleptomania commented 3 months ago

What else would you want it to say? It shows the problematic file.

You’re not meant to go reformat it by hand, it’s meant to run make.py format and it will fix it with the auto formatter.

pushfoo commented 3 months ago

I think it should suggest the following:

  1. running ./make.py format locally
  2. git diff to highlight changes

The current output is confusing because the following aren't clear:

pushfoo commented 3 months ago

Making those next steps clear matters because running ruff format changed a few hundred lines for me.

I reverted since I remembered we're using black + config tweaks this project, but beginners will get confused.