• 
      

    Clean up comment block and reviewable models

    Review Request #10191 — Created Oct. 3, 2018 and submitted

    Information

    Review Board
    release-4.0.x
    787f277...

    Reviewers

    The RB.AbstractCommentBlock and RB.AbstractReviewable heirarchies
    needed some cleaning up. Most of them were lacking documentation about
    what their model attributes were. Also the RB.DiffCommentBlock model
    was using ES5 style method: function() {...} definitions instead of
    ES6 style method() {...} definitions. Finally, the
    RB.FileAttachmentReviewable model was re-defining the caption
    attribute which it inherits from its parent model.

    All of these issues have been cleaned up. All model attributes are
    documented with links back to the parent models for additional
    attributes.

    Ran JS tests.

    Description From Last Updated

    Testing done?

    daviddavid

    Typo in the description's first line: "heirarchies" -> "hierarchies"

    chipx86chipx86

    I don't think we need to say "The jQuery object for ...", we can just say "The first row in …

    daviddavid

    Same here.

    daviddavid

    Can we alphabetise these?

    daviddavid

    Two periods.

    daviddavid

    typo: objecting?

    daviddavid

    Instead of "differ" (which is confusing with "diffed/diffs"), let's say "whether the attachments have different review UI types"

    daviddavid

    typo: textcurrently

    daviddavid

    Same comment about "the jquery object"

    daviddavid

    And here

    daviddavid

    Missing definitions for these.

    daviddavid

    "ID"

    chipx86chipx86

    :js:class:

    chipx86chipx86

    Array

    chipx86chipx86

    Array

    chipx86chipx86

    Array

    chipx86chipx86

    :js:class:

    chipx86chipx86

    Too many blank lines.

    chipx86chipx86

    :js:class:

    chipx86chipx86
    david
    1. 
        
    2. Show all issues

      Testing done?

    3. Show all issues

      I don't think we need to say "The jQuery object for ...", we can just say "The first row in the diffviewer". People know what a jquery is.

    4. Show all issues

      Same here.

    5. reviewboard/static/rb/js/models/abstractCommentBlockModel.es6.js (Diff revision 1)
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
       
      Show all issues

      Can we alphabetise these?

    6. Show all issues

      Two periods.

    7. Show all issues

      typo: objecting?

    8. Show all issues

      Instead of "differ" (which is confusing with "diffed/diffs"), let's say "whether the attachments have different review UI types"

    9. Show all issues

      typo: textcurrently

    10. Show all issues

      Same comment about "the jquery object"

    11. Show all issues

      And here

    12. Show all issues

      Missing definitions for these.

    13. 
        
    brennie
    david
    1. Ship It!
    2. 
        
    brennie
    chipx86
    1. 
        
    2. Show all issues

      Typo in the description's first line: "heirarchies" -> "hierarchies"

    3. Show all issues

      "ID"

    4. Show all issues

      :js:class:

    5. Show all issues

      Array

    6. Show all issues

      Array

    7. Show all issues

      Array

    8. Show all issues

      :js:class:

    9. Show all issues

      Too many blank lines.

    10. Show all issues

      :js:class:

    11. 
        
    brennie
    brennie
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-4.0.x (7fcbd8e)