Fix the misleading string in pop up "RBTool Setup" message in repository admin

Review Request #6788 — Created Jan. 16, 2015 and submitted

Information

Review Board
master
90d3959...

Reviewers

In the repository list in the Review Board admin site, we have an "RBTools Setup" link that pops up instructions for what to put in a .reviewboardrc file. One instruction was misleading (telling the user to work on root directory) in cases like SVN where the user won't be checking out the "repository root", but rather a subdirectory

The misleading string is produced by reviewboard/templates/admin/scmtools/repository/rbtools_setup.html I just changed some static string in the html file.

This change fixes the text to suggest users commit this file to the root of their working copy.

Show better string on Chrome after modification

Description From Last Updated

Please wrap this to 80 columns.

daviddavid
reviewbot
  1. Tool: Pyflakes
    Processed Files:
        reviewboard/reviews/views.py
    
    Ignored Files:
        reviewboard/templates/admin/scmtools/repository/rbtools_setup.html
    
    
    
    Tool: PEP8 Style Checker
    Processed Files:
        reviewboard/reviews/views.py
    
    Ignored Files:
        reviewboard/templates/admin/scmtools/repository/rbtools_setup.html
    
    
  2. 
      
Chester
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        reviewboard/templates/admin/scmtools/repository/rbtools_setup.html
    
    
    
    Tool: Pyflakes
    Ignored Files:
        reviewboard/templates/admin/scmtools/repository/rbtools_setup.html
    
    
  2. 
      
david
  1. Your review request description needs work. It should explain what the bug is and how your change fixes it.

    1. just added more details in description box

    2. Also, how does this relate to your other review request for this (/r/6786)? Should that one be discarded?

      There's also some typos in your summary: "reviewsboard", "revies"

  2. 
      
Chester
Chester
david
  1. Ahh, you'll need to change your summary too (it's for a different change)

  2. 
      
david
  1. 
      
  2. Show all issues

    Please wrap this to 80 columns.

  3. 
      
Chester
Chester
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        reviewboard/templates/admin/scmtools/repository/rbtools_setup.html
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        reviewboard/templates/admin/scmtools/repository/rbtools_setup.html
    
    
  2. 
      
david
  1. Your summary/description is improved, but still not very useful. For example, looking through git history, I would wonder "what string?" and "what pop up message"? You should also endeavor to use correct capitalization and punctuation.

    Here's an example of what we might expect for this bug fix:

    Fix misleading "RBTools Setup" instructions in the repository admin.
    
    In the repository list in the Review Board admin site, we have an "RBTools
    Setup" link that pops up instructions for what to put in a .reviewboardrc file.
    These instructions were misleading in cases like SVN where the user won't be
    checking out the "repository root", but rather a subdirectory.
    
    This change fixes the text to suggest users commit this file to the root of
    their working copy.
    
    1. changed it. Thank you!

  2. 
      
Chester
Chester
david
  1. Ship It!
  2. 
      
Chester
Review request changed
Status:
Completed
Change Summary:
Pushed to release-2.0.x (47bd1bf)