Redesign the issue summary table UI to speed up the process of addressing issues.
Review Request #6997 — Created Feb. 28, 2015 and discarded
Redesign the UI to make the issue summary table more useful, by:
- Making issue descriptions expand so that full content is viewable on click. This change allows the user to conveniently see full issue descriptions in-table, without having to click the description and be redirected to the comment itself.
A new div in review_issue_summary_table.html contains full comment text and is initially hidden.
The CSS class, 'issue-summary-collapsed,' is applied to this hidden div when the summary is collapsed. JS methods, onPreviewClicked and onFullClicked handle user clicks.
- Adding buttons to fix/drop issues in the issue summary table.
Each entry in the issue summary table now has a set of Fix and Drop buttons, visible when expanded, from which you can address the issue and the status of the issue will update everywhere. You can also continue to use the previously existing buttons in the review to fix, drop, or reopen, and the table will be updated accordingly.
Manual testing (expandable descriptions):
- Added long (past the 20 word cutoff mark) comments to a review request.
- Able to click the description in the issue summary table to see the full comment text.
- If the full text is being displayed, able to switch back to the 20 word version upon click.
(buttons):
- Clicking the Fix or Drop button when a description is expanded fades the issue out of the table and updates its status at the actual place in the review. It stays upon refreshing the page.Added new commentIssueBar unit tests and ran js-tests. All passed.
Description | From | Last Updated |
---|---|---|
There's three elements on here (the text, the buttons, and the See Comment), and none of them align. We should … |
chipx86 | |
No blank line here. |
brennie | |
Trailing whitespace. |
brennie | |
Trailing whitespace. |
brennie | |
Should begin with a capital |
brennie | |
Use single quotes. |
brennie | |
Use a multiline comment. |
brennie | |
Trailing whitespace. |
brennie | |
Use single quotes. Here and elsewhere. |
brennie | |
Space :D |
SU Sunxperous | |
Col: 1 E302 expected 2 blank lines, found 1 |
reviewbot | |
Col: 1 E302 expected 2 blank lines, found 1 |
reviewbot | |
Make sure your docstrings follow the proper format: """One-line summary.""" or: """One-line summary. Multi-line description. """ |
chipx86 | |
No need for the None parameter. It's implied. |
chipx86 | |
Everything in here is alphabetical but overflow/margin. Also, for margin, use 0 instead of 0px. |
chipx86 | |
Best to use either percentages, or to have a constant defined along with the other constant definitions, so that it's … |
chipx86 | |
A useful JavaScriptism is to do: !!this.options.inTable. That will keep true as true, but turn undefined, null, and false into … |
chipx86 | |
Blank line between these. |
chipx86 | |
The indentation needs to be 4 spaces, not 2. |
chipx86 | |
While here, can you remove the * in this line? |
chipx86 | |
Can you sort these alphabetically by selector? |
chipx86 | |
This needs a doc comment. |
chipx86 | |
Make sure to remove the trailing whitespace, here and below. |
chipx86 | |
Blank line between code and comments. All comments should follow sentence casing, with a trailing period. |
chipx86 | |
This is missing a var. It also should be called $hiddenDiv, since it's a jQuery element reference. Note that you … |
chipx86 | |
This is also missing a var, and needs to be named $link. These same comments all apply to the following … |
chipx86 | |
Best not to hard-code CSS here. Can we use class names instead? Same below where you set display: none. In … |
chipx86 | |
Needs a doc comment. |
chipx86 | |
Space after the comma. |
chipx86 | |
Missing a doc comment. |
chipx86 | |
Best to pull out $(this) into $this, so we don't have to wrap it more than once. |
chipx86 | |
If this shouldn't happen, we need to console.assert it. |
chipx86 | |
I don't believe you need to parseInt this. Can you check whether it comes back as an integer? I believe … |
chipx86 | |
This is really, really wordy, and hard to maintain and review. Please break it up into multiple lines where possible. … |
chipx86 | |
reviewtags and staticfiles are not used. |
chipx86 | |
Can you instead have display: none on issue-container? Also, each button label must be localized. |
chipx86 | |
Col: 1 E302 expected 2 blank lines, found 1 |
reviewbot | |
Col: 1 E302 expected 2 blank lines, found 1 |
reviewbot | |
Docstrings should be of the form: """Single line summary. Multi-line description. """ |
brennie | |
Remove trailing whitespace. |
brennie | |
Method doccomments should use multi-line comment syntax, e.g /* * Hide ... */ |
brennie | |
Method doccomments should use multi-line comment syntax, e.g /* * Hide ... */ |
brennie | |
Remove trailing whitespace. |
brennie | |
Method doccomments should use multi-line comment syntax, e.g /* * Create ... */ |
brennie | |
Can we assign $(this) to a variable (e.g., $this) and use that? |
brennie | |
Same here. |
brennie |
- Description:
-
Resolved merge conflicts in review_issue_summary_table.html (integrated markdown text and expandable summaries)
~ Adding the buttons (they don't show up/work yet)
~ Update: buttons now show up in the right place but they're not fully functional yet (clicking fix or drop doesn't affect the actual state of the issue)
- Commit:
-
4fe17d79ce84fb995f2ffe16fead9bdbbc8a1c434fe42e9abf6856a453817c492811aff015fcd761
- Diff:
-
Revision 2 (+121 -22)
-
Tool: Pyflakes Ignored Files: reviewboard/static/rb/js/.DS_Store reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js Tool: PEP8 Style Checker Ignored Files: reviewboard/static/rb/js/.DS_Store reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js
-
<p>You should add <code>.DS_Store</code> to your <code>~/.gitconfig</code>. Please remove the <code>.DS_Store</code> file from the review request.</p>
-
-
-
-
-
-
-
-
- Description:
-
+ From review request 6910 (Make descriptions in the issue summary table expandable so full comments are viewable in table on click):
+ Added a new div in review_issue_summary_table.html that contains full comment text and is initially hidden. + Added a new CSS class, 'issue-summary-collapsed,' to be applied to this hidden div when the summary is collapsed. + Added two new JS methods, onPreviewClicked and onFullClicked, for handling user clicks. + + This change allows the user to conveniently see full issue descriptions in-table, without having to click the description and be redirected to the comment itself.
+ + + Resolved merge conflicts in review_issue_summary_table.html (integrated markdown text and expandable summaries)
Update: buttons now show up in the right place but they're not fully functional yet (clicking fix or drop doesn't affect the actual state of the issue)
- Testing Done:
-
+ Manual testing (expandable descriptions):
+ - Added long (past the 20 word cutoff mark) comments to a review request. + - Able to click the description in the issue summary table to see the full comment text. + - If the full text is being displayed, able to switch back to the 20 word version upon click.
- Commit:
-
4fe42e9abf6856a453817c492811aff015fcd761017a106d34fb06edfeccf35fe5002c12002ffdd3
- Diff:
-
Revision 3 (+121 -21)
-
Tool: Pyflakes Ignored Files: reviewboard/static/rb/js/.DS_Store reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js Tool: PEP8 Style Checker Ignored Files: reviewboard/static/rb/js/.DS_Store reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js
-
Can you provide screenshots?
Also, make sure you're following our guidelines for the review request description: https://www.reviewboard.org/docs/codebase/dev/writing-good-descriptions/
- Summary:
-
[WIP] Adding buttons to fix/drop issues in the issue summary table[WIP] Redesign the issue summary table UI to speed up the process of addressing issues.
- Description:
-
~ From review request 6910 (Make descriptions in the issue summary table expandable so full comments are viewable in table on click):
~ Redesign the UI to make the issue summary table more useful, by:
- Added a new div in review_issue_summary_table.html that contains full comment text and is initially hidden. - Added a new CSS class, 'issue-summary-collapsed,' to be applied to this hidden div when the summary is collapsed. - Added two new JS methods, onPreviewClicked and onFullClicked, for handling user clicks. ~ This change allows the user to conveniently see full issue descriptions in-table, without having to click the description and be redirected to the comment itself.
~ - [Completed] Making issue descriptions expand so that full content is viewable on click. This change allows the user to conveniently see full issue descriptions in-table, without having to click the description and be redirected to the comment itself.
~ ~ A new div in review_issue_summary_table.html contains full comment text and is initially hidden.
+ The CSS class, 'issue-summary-collapsed,' is applied to this hidden div when the summary is collapsed. JS methods, onPreviewClicked and onFullClicked handle user clicks. ~ Resolved merge conflicts in review_issue_summary_table.html (integrated markdown text and expandable summaries)
~ - [WIP] Adding buttons to fix/drop issues in the issue summary table.
~ Update: buttons now show up in the right place but they're not fully functional yet (clicking fix or drop doesn't affect the actual state of the issue)
~ Buttons now show up in the right place but are not fully functional yet (clicking fix or drop doesn't affect the actual state of the issue).
- Added Files:
- Commit:
-
017a106d34fb06edfeccf35fe5002c12002ffdd34c14dab9f3d9ad2d297058969660913c0a82d2c9
- Diff:
-
Revision 4 (+121 -21)
-
Tool: Pyflakes Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/commentIssueBarView.js Tool: PEP8 Style Checker Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/commentIssueBarView.js
- Description:
-
Redesign the UI to make the issue summary table more useful, by:
- [Completed] Making issue descriptions expand so that full content is viewable on click. This change allows the user to conveniently see full issue descriptions in-table, without having to click the description and be redirected to the comment itself.
A new div in review_issue_summary_table.html contains full comment text and is initially hidden.
The CSS class, 'issue-summary-collapsed,' is applied to this hidden div when the summary is collapsed. JS methods, onPreviewClicked and onFullClicked handle user clicks. - [WIP] Adding buttons to fix/drop issues in the issue summary table.
~ Buttons now show up in the right place but are not fully functional yet (clicking fix or drop doesn't affect the actual state of the issue).
~ Buttons are now functional (clicking fix or drop affects the actual state of the issue), but do not redisplay properly when the issue is reopened (reappear but faded out).
- Testing Done:
-
Manual testing (expandable descriptions):
- Added long (past the 20 word cutoff mark) comments to a review request. - Able to click the description in the issue summary table to see the full comment text. ~ - If the full text is being displayed, able to switch back to the 20 word version upon click. ~ - If the full text is being displayed, able to switch back to the 20 word version upon click. + (buttons): + - Clicking the Fix or Drop button when a description is expanded fades the issue out of the table and updates its status at the actual place in the review. It stays upon refreshing the page. - Commit:
-
4c14dab9f3d9ad2d297058969660913c0a82d2c96be79dba65efb2ce74bdb47d6194b00120eebe4d
- Diff:
-
Revision 5 (+120 -21)
-
Tool: PEP8 Style Checker Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/commentIssueBarView.js Tool: Pyflakes Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/commentIssueBarView.js
- Commit:
-
6be79dba65efb2ce74bdb47d6194b00120eebe4d54f07a76df9a93fc6c911707a71eb54780d5167e
- Diff:
-
Revision 6 (+146 -21)
-
Tool: PEP8 Style Checker Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/commentIssueBarView.js Tool: Pyflakes Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/commentIssueBarView.js
-
- Description:
-
Redesign the UI to make the issue summary table more useful, by:
- [Completed] Making issue descriptions expand so that full content is viewable on click. This change allows the user to conveniently see full issue descriptions in-table, without having to click the description and be redirected to the comment itself.
A new div in review_issue_summary_table.html contains full comment text and is initially hidden.
The CSS class, 'issue-summary-collapsed,' is applied to this hidden div when the summary is collapsed. JS methods, onPreviewClicked and onFullClicked handle user clicks. ~ - [WIP] Adding buttons to fix/drop issues in the issue summary table.
~ - [Completed] Adding buttons to fix/drop issues in the issue summary table.
~ Buttons are now functional (clicking fix or drop affects the actual state of the issue), but do not redisplay properly when the issue is reopened (reappear but faded out).
~ Buttons are now functional (clicking fix or drop affects the actual state of the issue regardless of whether it was pressed in the table or in the review).
- Testing Done:
-
Manual testing (expandable descriptions):
- Added long (past the 20 word cutoff mark) comments to a review request. - Able to click the description in the issue summary table to see the full comment text. - If the full text is being displayed, able to switch back to the 20 word version upon click. (buttons): ~ - Clicking the Fix or Drop button when a description is expanded fades the issue out of the table and updates its status at the actual place in the review. It stays upon refreshing the page. ~ - Clicking the Fix or Drop button when a description is expanded fades the issue out of the table and updates its status at the actual place in the review. It stays upon refreshing the page. + Added new commentIssueBar tests and ran js-tests. - Commit:
-
54f07a76df9a93fc6c911707a71eb54780d5167efd528c901da6fd3daef55a140790b34c95f8f673
- Diff:
-
Revision 7 (+187 -20)
-
Tool: Pyflakes Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js Tool: PEP8 Style Checker Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js
-
-
-
There's three elements on here (the text, the buttons, and the See Comment), and none of them align. We should strive to have them align as best as possible.
-
Make sure your docstrings follow the proper format:
"""One-line summary."""
or:
"""One-line summary. Multi-line description. """
-
-
-
Best to use either percentages, or to have a constant defined along with the other constant definitions, so that it's easier to find and update this if we make major changes to the styling.
-
A useful JavaScriptism is to do:
!!this.options.inTable
. That will keeptrue
astrue
, but turnundefined
,null
, andfalse
intofalse
. -
-
-
-
-
-
-
Blank line between code and comments.
All comments should follow sentence casing, with a trailing period.
-
This is missing a
var
. It also should be called$hiddenDiv
, since it's a jQuery element reference.Note that you must have one
var
statement for all variables, comma-separated, one per line, and it must be at the top of the function.Also, is there a class name you can reference in the ancestry instead of doing
parent().parent()
? It'll help reduce breakages if we ever need to alter the DOM here. -
This is also missing a
var
, and needs to be named$link
.These same comments all apply to the following function.
-
Best not to hard-code CSS here. Can we use class names instead?
Same below where you set
display: none
.In general, though, if you need to hard-code CSS, you shouldn't modify
style
, but rather should.css('display', 'inline-block')
. -
-
-
-
-
-
I don't believe you need to
parseInt
this. Can you check whether it comes back as an integer? I believe.date()
takes care of this for you. -
This is really, really wordy, and hard to maintain and review. Please break it up into multiple lines where possible. You can use
{% spaceless %}...{% endspaceless %}
if there are issues with spaces causing problems.Also, note that the "See comment" must be localized.
-
-
- Commit:
-
fd528c901da6fd3daef55a140790b34c95f8f67393548d5f53ab54d9d82d4d982326c99b5665260a
- Diff:
-
Revision 8 (+203 -19)
-
Tool: Pyflakes Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js Tool: PEP8 Style Checker Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js
-
- Commit:
-
93548d5f53ab54d9d82d4d982326c99b5665260af882f5f2ffadf7078249a9836b38138dcf009029
- Diff:
-
Revision 9 (+197 -19)
-
Tool: PEP8 Style Checker Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js Tool: Pyflakes Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js
-
- Commit:
-
f882f5f2ffadf7078249a9836b38138dcf0090295b526e2420094c21427c4dd8247506de8135cacf
- Diff:
-
Revision 10 (+198 -19)
-
Tool: Pyflakes Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js
-
Tool: PEP8 Style Checker Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js
- Summary:
-
[WIP] Redesign the issue summary table UI to speed up the process of addressing issues.Redesign the issue summary table UI to speed up the process of addressing issues.
- Description:
-
Redesign the UI to make the issue summary table more useful, by:
~ - [Completed] Making issue descriptions expand so that full content is viewable on click. This change allows the user to conveniently see full issue descriptions in-table, without having to click the description and be redirected to the comment itself.
~ - Making issue descriptions expand so that full content is viewable on click. This change allows the user to conveniently see full issue descriptions in-table, without having to click the description and be redirected to the comment itself.
A new div in review_issue_summary_table.html contains full comment text and is initially hidden.
The CSS class, 'issue-summary-collapsed,' is applied to this hidden div when the summary is collapsed. JS methods, onPreviewClicked and onFullClicked handle user clicks. ~ - [Completed] Adding buttons to fix/drop issues in the issue summary table.
~ - Adding buttons to fix/drop issues in the issue summary table.
~ Buttons are now functional (clicking fix or drop affects the actual state of the issue regardless of whether it was pressed in the table or in the review).
~ Each entry in the issue summary table now has a set of Fix and Drop buttons, visible when expanded, from which you can address the issue and the status of the issue will update everywhere. You can also continue to use the previously existing buttons in the review to fix, drop, or reopen, and the table will be updated accordingly.
- Testing Done:
-
Manual testing (expandable descriptions):
- Added long (past the 20 word cutoff mark) comments to a review request. - Able to click the description in the issue summary table to see the full comment text. - If the full text is being displayed, able to switch back to the 20 word version upon click. (buttons): ~ - Clicking the Fix or Drop button when a description is expanded fades the issue out of the table and updates its status at the actual place in the review. It stays upon refreshing the page. ~ Added new commentIssueBar tests and ran js-tests. ~ - Clicking the Fix or Drop button when a description is expanded fades the issue out of the table and updates its status at the actual place in the review. It stays upon refreshing the page. ~ + Added new commentIssueBar unit tests and ran js-tests. All passed.
- Commit:
-
5b526e2420094c21427c4dd8247506de8135cacf1ad4a4f56102a47b3cde615e9a30449a53d2bee9
- Diff:
-
Revision 11 (+207 -19)
-
Tool: Pyflakes Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js Tool: PEP8 Style Checker Processed Files: reviewboard/reviews/templatetags/reviewtags.py Ignored Files: reviewboard/templates/reviews/table_comment_issue.html reviewboard/static/rb/js/views/commentIssueBarView.js reviewboard/templates/reviews/review_issue_summary_table.html reviewboard/static/rb/css/pages/reviews.less reviewboard/static/rb/js/views/issueSummaryTableView.js reviewboard/static/rb/js/views/tests/commentIssueBarViewTests.js