[Demo] Enhance and fix up the setup experience in prepare-dev.py.

Review Request #11951 — Created Jan. 21, 2022 and discarded

chipx86
Review Board
release-4.0.x
reviewboard

This modernizes the way we request input and display output on
prepare-dev.py, utilizing more of rb-site's ConsoleUI. This is a
better, more consistent way of displaying information and prompting for
information.

The text has been updated to be more user-friendly, to offer
guidance for when things go wrong, and to provide next steps when the
environment is prepared.

Ran through prepare-dev.py with a brand-new clone and database, and also
with an existing one.

Verified dependencies were installed.

Verified each new text string was correct and free from typos.

Summary
[Demo] Enhance and fix up the setup experience in prepare-dev.py.
Fixes from review feedback.
Description From Last Updated

Typo in description: prepare-dev.ppy -> prepare-dev.py

daviddavid

Can you flesh out the testing done?

daviddavid

There needs to be a blank line between the description and the type.

daviddavid

There's an extra space between "in" and "the"

daviddavid

E126 continuation line over-indented for hanging indent

reviewbotreviewbot

If this is meant to set the global variable, you need global ui

daviddavid

Please use single quotes instead of double.

daviddavid

Please add a blank line between these.

daviddavid

There's a missing space at the end of the first line.

daviddavid
Checks run (1 failed, 1 succeeded)
flake8 failed.
JSHint passed.

flake8

david
  1. Looks pretty good, just a few style issues and one important global variable problem.

  2. Typo in description: prepare-dev.ppy -> prepare-dev.py

  3. Can you flesh out the testing done?

  4. contrib/internal/prepare-dev.py (Diff revision 1)
     
     
     

    There needs to be a blank line between the description and the type.

  5. contrib/internal/prepare-dev.py (Diff revision 1)
     
     

    There's an extra space between "in" and "the"

  6. contrib/internal/prepare-dev.py (Diff revision 1)
     
     

    I've never seen this before, what does os.system do?

    1. It's used to execute processes. Similar to running a command in bash or any other shell. I might want to revisit this, move to subprocess.Popen.

  7. contrib/internal/prepare-dev.py (Diff revision 1)
     
     

    If this is meant to set the global variable, you need global ui

  8. contrib/internal/prepare-dev.py (Diff revision 1)
     
     

    Please use single quotes instead of double.

  9. contrib/internal/prepare-dev.py (Diff revision 1)
     
     
     

    Please add a blank line between these.

  10. contrib/internal/prepare-dev.py (Diff revision 1)
     
     
     

    There's a missing space at the end of the first line.

  11. 
      
chipx86
chipx86
david
Review request changed

Status: Discarded

Loading...