Skip to content

Commit

Permalink
Remove redundant "only" from "only does X if and only if Y", add comm…
Browse files Browse the repository at this point in the history
…as to make alternatives less ambiguous, and use HTML markup

PiperOrigin-RevId: 514394056
Change-Id: Icd2faa02d5e59bc204e8352bc84d8166d093cf57
  • Loading branch information
tkoeppe authored and copybara-github committed Mar 6, 2023
1 parent 28dc0f9 commit ebe4e2f
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -574,9 +574,9 @@ StarlarkCallable rule(
+ "one of the required providers lists. For example, if the "
+ "<code>required_providers</code> of an aspect are "
+ "<code>[[FooInfo], [BarInfo], [BazInfo, QuxInfo]]</code>, this aspect can "
+ "only see <code>some_rule</code> targets if and only if "
+ "<code>some_rule</code> provides <code>FooInfo</code> *or* "
+ "<code>BarInfo</code> *or* both <code>BazInfo</code> *and* "
+ "see <code>some_rule</code> targets if and only if "
+ "<code>some_rule</code> provides <code>FooInfo</code>, <em>or</em> "
+ "<code>BarInfo</code>, <em>or</em> both <code>BazInfo</code> <em>and</em> "
+ "<code>QuxInfo</code>."),
@Param(
name = "required_aspect_providers",
Expand All @@ -598,9 +598,9 @@ StarlarkCallable rule(
+ "aspect, <code>other_aspect</code> must provide all providers from at least "
+ "one of the lists. In the example of "
+ "<code>[[FooInfo], [BarInfo], [BazInfo, QuxInfo]]</code>, this aspect can "
+ "only see <code>other_aspect</code> if and only if <code>other_aspect</code> "
+ "provides <code>FooInfo</code> *or* <code>BarInfo</code> *or* both "
+ "<code>BazInfo</code> *and* <code>QuxInfo</code>."),
+ "see <code>other_aspect</code> if and only if <code>other_aspect</code> "
+ "provides <code>FooInfo</code>, <em>or</em> <code>BarInfo</code>, "
+ "<em>or</em> both <code>BazInfo</code> <em>and</em> <code>QuxInfo</code>."),
@Param(name = "provides", named = true, defaultValue = "[]", doc = PROVIDES_DOC),
@Param(
name = "requires",
Expand Down

0 comments on commit ebe4e2f

Please sign in to comment.