Skip to content

Commit

Permalink
Explain the use of str(Label(...)) in the docs
Browse files Browse the repository at this point in the history
Closes #19509.

PiperOrigin-RevId: 565763282
Change-Id: I0a8ede20b6bda5140a83c03a44577c034a54dd5f
  • Loading branch information
fmeum authored and copybara-github committed Sep 15, 2023
1 parent 184796d commit d9beda5
Showing 1 changed file with 8 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,14 @@
*
* <p>Parsing is robust against bad input, for example, from the command line.
*/
@StarlarkBuiltin(name = "Label", category = DocCategory.BUILTIN, doc = "A BUILD target identifier.")
@StarlarkBuiltin(
name = "Label",
category = DocCategory.BUILTIN,
doc =
"A BUILD target identifier."
+ "<p>For every <code>Label<code> instance <code>l</code>, the string representation"
+ " <code>str(l)</code> has the property that <code>Label(str(l)) == l</code>,"
+ " regardless of where the <code>Label()</code> call occurs.")
@AutoCodec
@Immutable
@ThreadSafe
Expand Down

0 comments on commit d9beda5

Please sign in to comment.