Summary

Fix up a couple things in API field docs.

Review Request #14260 — Created Dec. 4, 2024 and submitted Dec. 13, 2024, 3:53 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-7.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

The docs for fields across our API resources leave a lot to be desired,
but I came across some truly egregious things while working on the
RBTools stuff. This change fixes up a completely incorrect MIME type in
the WebHook resource, and some terrible grammar in the root comment
resources.

Testing Done

Ran unit tests.

Commits

Summary	ID
Fix up a couple things in API field docs. The docs for fields across our API resources leave a lot to be desired, but I came across some truly egregious things while working on the RBTools stuff. This change fixes up a completely incorrect MIME type in the WebHook resource, and some terrible grammar in the root comment resources. Testing Done: Ran unit tests.	3a88ff32f51cff8d0fa81daf873279151424f58a

Issues

Description	From	Last Updated
line too long (82 > 79 characters) Column: 80 Error code: E501	reviewbot	Dec. 4, 2024, 9:41 a.m.
line too long (80 > 79 characters) Column: 80 Error code: E501	reviewbot	Dec. 4, 2024, 9:41 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/webapi/resources/root_diff_comment.py (Diff revision 1)
The issue has been dropped. Show all issues
```
line too long (82 > 79 characters)

Column: 80
Error code: E501
```
reviewboard/webapi/resources/root_diff_comment.py (Diff revision 1)
The issue has been dropped. Show all issues
```
line too long (80 > 79 characters)

Column: 80
Error code: E501
```

Commits:

	Summary	ID
	Fix up a couple things in API field docs. The docs for fields across our API resources leave a lot to be desired, but I came across some truly egregious things while working on the RBTools stuff. This change fixes up a completely incorrect MIME type in the WebHook resource, and some terrible grammar in the root comment resources. Testing Done: Ran unit tests.	7d520067e570a4f631e4dac222c36fd6c7571ccf
	Fix up a couple things in API field docs. The docs for fields across our API resources leave a lot to be desired, but I came across some truly egregious things while working on the RBTools stuff. This change fixes up a completely incorrect MIME type in the WebHook resource, and some terrible grammar in the root comment resources. Testing Done: Ran unit tests.	3a88ff32f51cff8d0fa81daf873279151424f58a

Diff:

Revision 2 (+46 -46)

Show changes

	reviewboard/webapi/resources/root_diff_comment.py
	reviewboard/webapi/resources/root_file_attachment_comment.py
	reviewboard/webapi/resources/root_general_comment.py
	reviewboard/webapi/resources/webhook.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.x (d7e220d)