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

Review Request #11393 — Created Jan. 21, 2021 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 should be a blank line between these two.

daviddavid

Typo: two spaces between "in" and "the"

daviddavid

E126 continuation line over-indented for hanging indent

reviewbotreviewbot

We need to add global ui here to assign to the global.

daviddavid

Please use single quotes for this string.

daviddavid

Please add a blank line.

daviddavid

These two strings will get concatenated, so the first one needs a space at the end.

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

flake8

david
  1. Looking ok, just a few small issues and one big one (see global ui comment)

  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 should be a blank line between these two.

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

    Typo: two spaces between "in" and "the"

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

    What does os.system do?

    1. It's used to execute processes, similar to running a command in a shell. It's not always the right approach — the subprocess module is sometimes the better solution here.

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

    We need to add global ui here to assign to the global.

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

    Please use single quotes for this string.

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

    Please add a blank line.

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

    These two strings will get concatenated, so the first one needs a space at the end.

  11. 
      
chipx86
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Discarded

Change Summary:

Completed the demo for Spring 2021.1.

Loading...