Skip to content

Commit b13d23e

Browse files
vapiercopybara-github
authored andcommitted
rewrite reviewers help text
Fix some errors, improve wording to remove redundancy, and improve style. PiperOrigin-RevId: 742454824 Change-Id: I2a619049d1c953b2eb0222e841c9a1e98a3bd4be
1 parent c6f0aa1 commit b13d23e

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3237,7 +3237,7 @@ Parameter | Description
32373237
<span id=git.gerrit_destination.notify href=#git.gerrit_destination.notify>notify</span> | <code><a href="#string">string</a></code> or <code>NoneType</code><br><p>Type of Gerrit notify option (https://gerrit-review.googlesource.com/Documentation/user-upload.html#notify). Sends notifications by default.</p>
32383238
<span id=git.gerrit_destination.change_id_policy href=#git.gerrit_destination.change_id_policy>change_id_policy</span> | <code><a href="#string">string</a></code><br><p>What to do in the presence or absent of Change-Id in message:<ul> <li>`'REQUIRE'`: Require that the change_id is present in the message as a valid label</li> <li>`'FAIL_IF_PRESENT'`: Fail if found in message</li> <li>`'REUSE'`: Reuse if present. Otherwise generate a new one</li> <li>`'REPLACE'`: Replace with a new one if found</li></ul></p>
32393239
<span id=git.gerrit_destination.allow_empty_diff_patchset href=#git.gerrit_destination.allow_empty_diff_patchset>allow_empty_diff_patchset</span> | <code><a href="#bool">bool</a></code><br><p>By default Copybara will upload a new PatchSet to Gerrit without checking the previous one. If this set to false, Copybara will download current PatchSet and check the diff against the new diff.</p>
3240-
<span id=git.gerrit_destination.reviewers href=#git.gerrit_destination.reviewers>reviewers</span> | <code>sequence</code><br><p>The list of the reviewers will be added to gerrit change reviewer listThe element in the list is: an email, for example: "[email protected]" or label for example: ${SOME_GERRIT_REVIEWER}. These are under the condition of assuming that users have registered to gerrit repos</p>
3240+
<span id=git.gerrit_destination.reviewers href=#git.gerrit_destination.reviewers>reviewers</span> | <code>sequence</code><br><p>The list of the reviewers to add. Each element in the list is: an email (e.g. `"[email protected]"` or label (e.g. `"${SOME_GERRIT_REVIEWER}`). These assume that users have already registered on the Gerrit host and has access to the repos.</p>
32413241
<span id=git.gerrit_destination.cc href=#git.gerrit_destination.cc>cc</span> | <code>sequence</code><br><p>The list of the email addresses or users that will be CCed in the review. Can use labels as the `reviewers` field.</p>
32423242
<span id=git.gerrit_destination.labels href=#git.gerrit_destination.labels>labels</span> | <code>sequence</code><br><p>The list of labels to be pushed with the change. The format is the label along with the associated value. For example: Run-Presubmit+1</p>
32433243
<span id=git.gerrit_destination.api_checker href=#git.gerrit_destination.api_checker>api_checker</span> | <code><a href="#checker">checker</a></code> or <code>NoneType</code><br><p>A checker for the Gerrit API endpoint provided for after_migration hooks. This field is not required if the workflow hooks don't use the origin/destination endpoints.</p>

java/com/google/copybara/git/GitModule.java

+14-14
Original file line numberDiff line numberDiff line change
@@ -2429,10 +2429,10 @@ private ImmutableSetMultimap<String, Conclusion> convertSlugToConclusion(
24292429
named = true,
24302430
defaultValue = "[]",
24312431
doc =
2432-
"The list of the reviewers will be added to gerrit change reviewer listThe element"
2433-
+ " in the list is: an email, for example: \"[email protected]\" or label for"
2434-
+ " example: ${SOME_GERRIT_REVIEWER}. These are under the condition of"
2435-
+ " assuming that users have registered to gerrit repos"),
2432+
"The list of the reviewers to add. Each element in the list is:"
2433+
+ " an email (e.g. `\"[email protected]\"` or label (e.g. "
2434+
+ " `\"${SOME_GERRIT_REVIEWER}`). These assume that users have already"
2435+
+ " registered on the Gerrit host and has access to the repos."),
24362436
@Param(
24372437
name = "cc",
24382438
named = true,
@@ -2523,16 +2523,16 @@ private ImmutableSetMultimap<String, Conclusion> convertSlugToConclusion(
25232523
+ "is used, that checker will only apply to API calls.",
25242524
named = true,
25252525
positional = false),
2526-
@Param(
2527-
name = "credentials",
2528-
allowedTypes = {
2529-
@ParamType(type = UsernamePasswordIssuer.class),
2530-
@ParamType(type = NoneType.class),
2531-
},
2532-
defaultValue = "None",
2533-
named = true,
2534-
positional = false,
2535-
doc = CREDENTIAL_DOC)
2526+
@Param(
2527+
name = "credentials",
2528+
allowedTypes = {
2529+
@ParamType(type = UsernamePasswordIssuer.class),
2530+
@ParamType(type = NoneType.class),
2531+
},
2532+
defaultValue = "None",
2533+
named = true,
2534+
positional = false,
2535+
doc = CREDENTIAL_DOC)
25362536
},
25372537
useStarlarkThread = true)
25382538
@UsesFlags({GitDestinationOptions.class, GerritOptions.class})

0 commit comments

Comments
 (0)