Skip to content

Commit

Permalink
Remove outdated docs on depset()'s items parameter
Browse files Browse the repository at this point in the history
The `items` positional parameter was removed in f22d52e (released in Bazel version 5.0.0).

Closes #19218.

PiperOrigin-RevId: 564857831
Change-Id: I3fd4b416275aff3d373b9987164845dca9de647c
  • Loading branch information
timothyg-stripe authored and copybara-github committed Sep 12, 2023
1 parent 7a4eefa commit a75644e
Showing 1 changed file with 1 addition and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -578,15 +578,7 @@ private DepsetLibrary() {}
+ "<p> The order of the created depset should be <i>compatible</i> with the order"
+ " of its <code>transitive</code> depsets. <code>\"default\"</code> order is"
+ " compatible with any other order, all other orders are only compatible with"
+ " themselves.\n" //
+ "<p> Note on backward/forward compatibility. This function currently accepts a"
+ " positional <code>items</code> parameter. It is deprecated and will be removed"
+ " in the future, and after its removal <code>direct</code> will become a sole"
+ " positional parameter of the <code>depset</code> function. Thus, both of the"
+ " following calls are equivalent and future-proof:<br>\n" //
+ "<pre class=language-python>depset(['a', 'b'], transitive = [...])\n" //
+ "depset(direct = ['a', 'b'], transitive = [...])\n" //
+ "</pre>",
+ " themselves.",
parameters = {
// TODO(cparsons): Make 'order' keyword-only.
@Param(
Expand Down

0 comments on commit a75644e

Please sign in to comment.