Skip to content

Improve make script ergonomics & documentation #1739

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

Conversation

pushfoo
Copy link
Member

@pushfoo pushfoo commented Apr 30, 2023

Changes

  • Document how to enable running ./make.py instead of python make.py for Mac & Linux users
  • Document how to enable tab completions for ./make.py
  • Add a ./make.py whichshell sub-command to assist users with setting up tab completion

How to test

Both sets of instructions assume you are on Linux or a Mac

Testing short-form invocation & Shell Checking

  1. Follow the instructions for enabling ./make.py
  2. Run ./make.py whichshell to make sure it reports your default shell correctly

Testing Shell Completion

  1. If you are running a supported shell, follow the included instructions
  2. Type ./make.py h
  3. Press tab
  4. Observe the result; it should auto-complete to ./make.py html

@pushfoo
Copy link
Member Author

pushfoo commented Apr 30, 2023

  1. I think the shebang line and chmod doc is definitely worth keeping
  2. We can revert or split off the bash completion part to avoid conflict with Typechecking improvements #1738
  3. Please provide feedback on which direction would be best

@pvcraven pvcraven merged commit 37a3a6f into pythonarcade:development Apr 30, 2023
@pushfoo pushfoo deleted the improve_make_script_ergonomics branch May 7, 2023 06:04
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