[6.4.0] Explain the use of str(Label(...)) in the docs (#19554)

Closes #19509. Commit d9beda5 PiperOrigin-RevId: 565763282 Change-Id: I0a8ede20b6bda5140a83c03a44577c034a54dd5f Co-authored-by: Fabian Meumertzheim <[email protected]>
bazelbuild · Sep 18, 2023 · ec8c12d · ec8c12d
1 parent 7b72c02
commit ec8c12d
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/main/java/com/google/devtools/build/lib/cmdline/Label.java b/src/main/java/com/google/devtools/build/lib/cmdline/Label.java
@@ -53,7 +53,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