Add some documentation for the Tool class in the Review Bot worker.

Review Request #11510 — Created March 10, 2021 and submitted

Information

ReviewBot
release-3.0.x

Reviewers

The Tool class had some important fields that were not explained. For
instance the version field, if changed, could break existing
configurations, and should only be done if introducing breaking changes
to the tool.

To avoid problems in the future, and to prepare for some upcoming work,
these fields, and some other docs in the file, have been fleshed out.

Checked for spelling errors in the docs.

Summary ID
Add some documentation for the Tool class in the Review Bot worker.
The `Tool` class had some important fields that were not explained. For instance the `version` field, if changed, could break existing configurations, and should only be done if introducing breaking changes to the tool. To avoid problems in the future, and to prepare for some upcoming work, these fields, and some other docs in the file, have been fleshed out.
a1a7f2b3073c95cbb9fd95a390f0b0e3250a359c
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (f7120a1)
Loading...