Summary

Reorganize settings for the diff viewer.

Review Request #12781 — Created Jan. 11, 2023 and submitted Feb. 2, 2023, 1:45 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This now groups the settings into 3 fieldsets:

Appearance
Limits
Advanced

Appearance contains the checkboxes for trailing whitespace and syntax
highlighting, plus the field for mapping file extensions to
highlighters.

Limits contains the diff size limit and the max lines for syntax
highlighting.

Advanced contains everything it had before, plus the "Show all
whitespace for" field, which should generally no longer be used.

Some of the field labels and help text have been tweaked to be more
clear and to provide recommendations.

Testing Done

Verified the page's contents on desktop and mobile.

Checked for spelling errors.

Commits

Summary	ID
Reorganize settings for the diff viewer. The diff viewer settings page is one of the oldest pages in the admin UI, and its organization left much to be desired. Some upcoming work will be adding to this page, and as such, it's time to clean it up. This now groups the settings into 3 fieldsets: * Appearance * Limits * Advanced Appearance contains the checkboxes for trailing whitespace and syntax highlighting, plus the field for mapping file extensions to highlighters. Limits contains the diff size limit and the max lines for syntax highlighting. Advanced contains everything it had before, plus the "Show all whitespace for" field, which should generally no longer be used. Some of the field labels and help text have been tweaked to be more clear and to provide recommendations.	7658e3f0522a37c46183d9efad28d894e184cbf0

Summary

Reorganize settings for the diff viewer.

The diff viewer settings page is one of the oldest pages in the admin UI, and its organization left much to be desired. Some upcoming work will be adding to this page, and as such, it's time to clean it up. This now groups the settings into 3 fieldsets: * Appearance * Limits * Advanced Appearance contains the checkboxes for trailing whitespace and syntax highlighting, plus the field for mapping file extensions to highlighters. Limits contains the diff size limit and the max lines for syntax highlighting. Advanced contains everything it had before, plus the "Show all whitespace for" field, which should generally no longer be used. Some of the field labels and help text have been tweaked to be more clear and to provide recommendations.

7658e3f0522a37c46183d9efad28d894e184cbf0

Files

Issues

Description	From	Last Updated
Can we also mention in here that larger diffs can cause connection errors or browser performance problems? I feel like …	david	Jan. 25, 2023, 5:25 p.m.

flake8 passed.

JSHint passed.

reviewboard/admin/forms/diff_settings.py (Diff revision 1)

The issue has been resolved. Show all issues

Can we also mention in here that larger diffs can cause connection errors or browser performance problems? I feel like just saying it's too big for humans isn't a good disincentive.

While this is top of mind, we really need to change the default here too.

chipx86 Jan. 25, 2023, 5:25 p.m.

I'll take care of the default separately.

Change Summary:

Improved wording around the max diff size to mention the performance issues/timeouts that could occur.

Commits:

	Summary	ID
	Reorganize settings for the diff viewer. The diff viewer settings page is one of the oldest pages in the admin UI, and its organization left much to be desired. Some upcoming work will be adding to this page, and as such, it's time to clean it up. This now groups the settings into 3 fieldsets: * Appearance * Limits * Advanced Appearance contains the checkboxes for trailing whitespace and syntax highlighting, plus the field for mapping file extensions to highlighters. Limits contains the diff size limit and the max lines for syntax highlighting. Advanced contains everything it had before, plus the "Show all whitespace for" field, which should generally no longer be used. Some of the field labels and help text have been tweaked to be more clear and to provide recommendations.	eb60fba795159c383b326bedfed816691848e08d
	Reorganize settings for the diff viewer. The diff viewer settings page is one of the oldest pages in the admin UI, and its organization left much to be desired. Some upcoming work will be adding to this page, and as such, it's time to clean it up. This now groups the settings into 3 fieldsets: * Appearance * Limits * Advanced Appearance contains the checkboxes for trailing whitespace and syntax highlighting, plus the field for mapping file extensions to highlighters. Limits contains the diff size limit and the max lines for syntax highlighting. Advanced contains everything it had before, plus the "Show all whitespace for" field, which should generally no longer be used. Some of the field labels and help text have been tweaked to be more clear and to provide recommendations.	7658e3f0522a37c46183d9efad28d894e184cbf0

Diff:

Revision 2 (+110 -46)

Show changes

reviewboard/admin/forms/diff_settings.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.0.x (b3b595b)