• 
      

    Add a document on reviewing text files.

    Review Request #6452 — Created Oct. 16, 2014 and submitted

    Information

    Review Board
    release-2.0.x
    556670d...

    Reviewers

    2.0.x includes a text file review UI, which syntax highlights based on the
    mimetype and allows adding comments to each line, much like the diff viewer.
    While we were shipping the feature, we never had any documentation about it.

    Built and checked html docs.

    Description From Last Updated

    This feels a little hard to read. How about: "Any existing comments will show up as blue clickable comment flags …

    chipx86chipx86
    reviewbot
    1. Tool: Pyflakes
      Ignored Files:
          docs/manual/users/reviews/reviewing-text-files.rst
          docs/manual/users/reviews/text-review-ui.png
          docs/manual/users/reviews/reviewing-files.rst
          docs/manual/users/reviews/index.rst
          docs/manual/users/reviews/text-review-ui@2x.png
      
      
      
      Tool: PEP8 Style Checker
      Ignored Files:
          docs/manual/users/reviews/reviewing-text-files.rst
          docs/manual/users/reviews/text-review-ui.png
          docs/manual/users/reviews/reviewing-files.rst
          docs/manual/users/reviews/index.rst
          docs/manual/users/reviews/text-review-ui@2x.png
      
      
    2. 
        
    chipx86
    1. 
        
    2. Show all issues

      This feels a little hard to read. How about:

      "Any existing comments will show up as blue clickable comment flags along the left-hand side of the text file. Each comment flag corresponds to a line containing a comment."

      Or something.

    3. 
        
    david
    reviewbot
    1. Tool: PEP8 Style Checker
      Ignored Files:
          docs/manual/users/reviews/text-review-ui@2x.png
          docs/manual/users/reviews/reviewing-files.rst
          docs/manual/users/reviews/reviewing-text-files.rst
          docs/manual/users/reviews/text-review-ui.png
          docs/manual/users/reviews/index.rst
          docs/manual/users/reviews/reviewing-diffs.rst
      
      
      
      Tool: Pyflakes
      Ignored Files:
          docs/manual/users/reviews/text-review-ui@2x.png
          docs/manual/users/reviews/reviewing-files.rst
          docs/manual/users/reviews/reviewing-text-files.rst
          docs/manual/users/reviews/text-review-ui.png
          docs/manual/users/reviews/index.rst
          docs/manual/users/reviews/reviewing-diffs.rst
      
      
    2. 
        
    chipx86
    1. Ship It!

    2. 
        
    david
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-2.0.x (722f738)