Clean up comment block and reviewable models
Review Request #10191 — Created Oct. 3, 2018 and submitted
The
RB.AbstractCommentBlock
andRB.AbstractReviewable
heirarchies
needed some cleaning up. Most of them were lacking documentation about
what their model attributes were. Also theRB.DiffCommentBlock
model
was using ES5 stylemethod: function() {...}
definitions instead of
ES6 stylemethod() {...}
definitions. Finally, the
RB.FileAttachmentReviewable
model was re-defining thecaption
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? |
|
|
Typo in the description's first line: "heirarchies" -> "hierarchies" |
|
|
I don't think we need to say "The jQuery object for ...", we can just say "The first row in … |
|
|
Same here. |
|
|
Can we alphabetise these? |
|
|
Two periods. |
|
|
typo: objecting? |
|
|
Instead of "differ" (which is confusing with "diffed/diffs"), let's say "whether the attachments have different review UI types" |
|
|
typo: textcurrently |
|
|
Same comment about "the jquery object" |
|
|
And here |
|
|
Missing definitions for these. |
|
|
"ID" |
|
|
:js:class: |
|
|
Array |
|
|
Array |
|
|
Array |
|
|
:js:class: |
|
|
Too many blank lines. |
|
|
:js:class: |
|
-
-
-
reviewboard/static/rb/js/diffviewer/models/diffCommentBlockModel.es6.js (Diff revision 1) 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.
-
reviewboard/static/rb/js/diffviewer/models/diffCommentBlockModel.es6.js (Diff revision 1) Same here.
-
reviewboard/static/rb/js/models/abstractCommentBlockModel.es6.js (Diff revision 1) Can we alphabetise these?
-
-
-
reviewboard/static/rb/js/models/fileAttachmentReviewableModel.es6.js (Diff revision 1) Instead of "differ" (which is confusing with "diffed/diffs"), let's say "whether the attachments have different review UI types"
-
reviewboard/static/rb/js/models/textBasedCommentBlockModel.es6.js (Diff revision 1) typo: textcurrently
-
reviewboard/static/rb/js/models/textBasedCommentBlockModel.es6.js (Diff revision 1) Same comment about "the jquery object"
-
-
reviewboard/static/rb/js/models/textBasedReviewableModel.es6.js (Diff revision 1) Missing definitions for these.
Change Summary:
Addressed feedback
Testing Done: |
|
||||
---|---|---|---|---|---|
Commit: |
|
||||
Diff: |
Revision 2 (+209 -3) |
Checks run (2 succeeded)
Change Summary:
Fix depends-on relationship.
Depends On: |
|
---|
-
-
-
-
-
-
-
-
-
reviewboard/static/rb/js/models/textBasedCommentBlockModel.es6.js (Diff revision 2) Too many blank lines.
-
Change Summary:
Addressed feedback