Summary

Improve documentation for mimetypes and API server capabilities.

Review Request #9288 — Created Oct. 18, 2017 and submitted Oct. 22, 2017, 10:24 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Commit

86eac71...

Reviewers

Groups

reviewboard

People

Description

This modernizes some of the documentation for mimetypes and API server

capabilities, based on the work done on the extension hooks. It adds

documentation for arguments and return types and adds a file-level

docstring for the code reference index.

Testing Done

Built the docs and looked through them. No build errors.

Issues

Description	From	Last Updated
This is probably much better done with format_html_join, in which case the return type of this method will match the …	david	Oct. 21, 2017, 6:30 p.m.
Should we mark_safe?	david	Oct. 21, 2017, 6:30 p.m.
Should we mark_safe?	david	Oct. 21, 2017, 6:30 p.m.

flake8 passed.

JSHint passed.

These comments aren't really about the documentation, but about some inconsistencies that said documentation made obvious.

chipx86 Oct. 21, 2017, 5:48 p.m.

I noticed these as well (plus another Markdown-related improvement we can make), and have a change in progress for some of it. I'm going to keep this one about the docs and post a new one later today with the fixes.

chipx86 Oct. 21, 2017, 6:30 p.m.

Fixed up in https://reviews.reviewboard.org/r/9303/. Dropping them here, since they're not fixed in this change.

reviewboard/attachments/mimetypes.py (Diff revision 1)

The issue has been dropped. Show all issues

This is probably much better done with format_html_join, in which case the return type of this method will match the others (SafeText)

reviewboard/attachments/mimetypes.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Should we mark_safe?
```
reviewboard/attachments/mimetypes.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Should we mark_safe?
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (1849644)