opendev/gerrit
Code Issues Proposed changes

dev-plugins: Improve formatting of reviewer suggestion documentation

Browse Source 
- Add backticks around code
- Add line breaks to split the wall-of-text into logical paragraphs
- Reword the paragraph about configuring the plugin weight

Change-Id: Ic9997036c94ef2fc0e46a1ff62fa8c42c7ef7fc2
This commit is contained in:
David Pursehouse 2018-02-07 10:31:05 +09:00
parent 4657155eec
commit c2233a492d
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/dev-plugins.txt
View File

@ -2493,15 +2493,18 @@ new RestApi("accounts").id("self").view("username")
Gerrit provides an extension point that enables Plugins to rank Gerrit provides an extension point that enables Plugins to rank
the list of reviewer suggestion a user receives upon clicking "Add Reviewer" on the list of reviewer suggestion a user receives upon clicking "Add Reviewer" on
the change screen. the change screen.
Gerrit supports both a default suggestion that appears when the user has not yet Gerrit supports both a default suggestion that appears when the user has not yet
typed anything and a filtered suggestion that is shown as the user starts typed anything and a filtered suggestion that is shown as the user starts
typing. typing.
Plugins receive a candidate list and can return a Set of suggested reviewers
containing the Account.Id and a score for each reviewer. Plugins receive a candidate list and can return a `Set` of suggested reviewers
The candidate list is non-binding and plugins can choose to return reviewers not containing the `Account.Id` and a score for each reviewer. The candidate list is
initially contained in the candidate list. non-binding and plugins can choose to return reviewers not initially contained in
Server administrators can configure the overall weight of each plugin using the the candidate list.
weight config parameter on [addreviewer "<pluginName-exportName>"].
Server administrators can configure the overall weight of each plugin by setting
the `addreviewer.pluginName-exportName.weight` value in `gerrit.config`.
[source, java] [source, java]
---- ----