Add docstring to a build_setting rule (#116)

bazelbuild · Feb 9, 2022 · 6c6cfa2 · 6c6cfa2
1 parent f4d4b3a
commit 6c6cfa2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/test/testdata/config_apis_test/golden.md b/test/testdata/config_apis_test/golden.md
@@ -10,7 +10,7 @@
 int_setting(<a href="#int_setting-name">name</a>)
 </pre>
 
-
+An integer flag.
 
 **ATTRIBUTES**
 
@@ -28,7 +28,7 @@ int_setting(<a href="#int_setting-name">name</a>)
 string_flag(<a href="#string_flag-name">name</a>)
 </pre>
 
-
+A string flag.
 
 **ATTRIBUTES**
 

diff --git a/test/testdata/config_apis_test/input.bzl b/test/testdata/config_apis_test/input.bzl
@@ -15,11 +15,13 @@ def _build_setting_impl(ctx):
     return []
 
 string_flag = rule(
+    doc = "A string flag.",
     implementation = _build_setting_impl,
     build_setting = config.string(flag = True),
 )
 
 int_setting = rule(
+    doc = "An integer flag.",
     implementation = _build_setting_impl,
     build_setting = config.int(flag = False),
 )