Update golden files

bazelbuild · Oct 1, 2021 · e831911 · e831911
1 parent 6467aba
commit e831911
Show file tree

Hide file tree

Showing 34 changed files with 76 additions and 4 deletions.
diff --git a/docs/stardoc_rule.md b/docs/stardoc_rule.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+Starlark rule for stardoc: a documentation generator tool written in Java.
+
 <a id="#stardoc"></a>
 
 ## stardoc

diff --git a/setup.bzl b/setup.bzl
@@ -25,9 +25,11 @@ def stardoc_repositories():
     _include_if_not_defined(
         http_archive,
         name = "bazel_skylib",
-        urls = ["https://github.com/bazelbuild/bazel-skylib/archive/16de038c484145363340eeaf0e97a0c9889a931b.tar.gz"],  # 2020-08-11
-        sha256 = "96e0cd3f731f0caef9e9919aa119ecc6dace36b149c2f47e40aa50587790402b",
-        strip_prefix = "bazel-skylib-16de038c484145363340eeaf0e97a0c9889a931b",
+        sha256 = "58f558d04a936cade1d4744d12661317e51f6a21e3dd7c50b96dc14f3fa3b87d",
+        strip_prefix = "bazel-skylib-df3c9e2735f02a7fe8cd80db4db00fec8e13d25f",
+        urls = [
+            "https://github.com/bazelbuild/bazel-skylib/archive/df3c9e2735f02a7fe8cd80db4db00fec8e13d25f.tar.gz",
+        ],
     )
     _include_if_not_defined(
         http_archive,

diff --git a/test/BUILD b/test/BUILD
@@ -1,6 +1,11 @@
+"""Golden file tests
+
+To update all the golden files after a logic change, run
+update-stardoc-tests.sh
+"""
+
 load(":stardoc_test.bzl", "stardoc_test")
 load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
-load("@bazel_skylib//rules:write_file.bzl", "write_file")
 
 licenses(["notice"])  # Apache 2.0
 

diff --git a/test/stardoc_test.bzl b/test/stardoc_test.bzl
@@ -91,6 +91,7 @@ def _create_test_targets(
 
     diff_test(
         name = test_name,
+        failure_message = "Please run update-stardoc-tests.sh",
         file1 = actual_generated_doc,
         file2 = golden_file,
     )

diff --git a/test/testdata/android_basic_test/golden.md b/test/testdata/android_basic_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#android_related_rule"></a>
 
 ## android_related_rule

diff --git a/test/testdata/angle_bracket_test/golden.md b/test/testdata/angle_bracket_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+Input file to test angle bracket bug (https://github.com/bazelbuild/skydoc/issues/186)
+
 <a id="#my_anglebrac"></a>
 
 ## my_anglebrac

diff --git a/test/testdata/apple_basic_test/golden.md b/test/testdata/apple_basic_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#apple_related_rule"></a>
 
 ## apple_related_rule

diff --git a/test/testdata/aspect_test/golden.md b/test/testdata/aspect_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+The input file for the aspect test
+
 <a id="#my_aspect_impl"></a>
 
 ## my_aspect_impl

diff --git a/test/testdata/attribute_defaults_test/golden.md b/test/testdata/attribute_defaults_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+A golden test to verify attribute default values.
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/attribute_types_test/golden.md b/test/testdata/attribute_types_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/cc_api_test/golden.md b/test/testdata/cc_api_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+Input file for C++ api test 
+
 <a id="#cpp_related_rule"></a>
 
 ## cpp_related_rule

diff --git a/test/testdata/config_apis_test/golden.md b/test/testdata/config_apis_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#int_setting"></a>
 
 ## int_setting

diff --git a/test/testdata/cpp_basic_test/golden.md b/test/testdata/cpp_basic_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#cpp_related_rule"></a>
 
 ## cpp_related_rule

diff --git a/test/testdata/filter_rules_test/golden.md b/test/testdata/filter_rules_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/function_basic_test/golden.md b/test/testdata/function_basic_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+A test that verifies basic user function documentation.
+
 <a id="#check_sources"></a>
 
 ## check_sources

diff --git a/test/testdata/generated_bzl_test/golden.md b/test/testdata/generated_bzl_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+A direct dependency file of the input file.
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/html_tables_template_test/golden.md b/test/testdata/html_tables_template_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+Input file for markdown template test
+
 <a id="#example_rule"></a>
 
 ## example_rule

diff --git a/test/testdata/java_basic_test/golden.md b/test/testdata/java_basic_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#java_related_rule"></a>
 
 ## java_related_rule

diff --git a/test/testdata/local_repository_test/golden.md b/test/testdata/local_repository_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+A test that verifies documenting functions in an input file under a local_repository.
+
 <a id="#min"></a>
 
 ## min

diff --git a/test/testdata/macro_kwargs_test/golden.md b/test/testdata/macro_kwargs_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+Tests for functions which use *args or **kwargs
+
 <a id="#macro_with_args"></a>
 
 ## macro_with_args

diff --git a/test/testdata/misc_apis_test/golden.md b/test/testdata/misc_apis_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/multi_level_namespace_test/golden.md b/test/testdata/multi_level_namespace_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+A test that verifies documenting a multi-leveled namespace of functions.
+
 <a id="#my_namespace.min"></a>
 
 ## my_namespace.min

diff --git a/test/testdata/multi_level_namespace_test_with_whitelist/golden.md b/test/testdata/multi_level_namespace_test_with_whitelist/golden.md
@@ -1,5 +1,9 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+A test that verifies documenting a multi-leveled namespace of functions with whitelist symbols.
+The whitelist symbols should cause everything in my_namespace to to be documented, but only a
+specific symbol in other_namespace to be documented.
+
 <a id="#my_namespace.min"></a>
 
 ## my_namespace.min

diff --git a/test/testdata/multiple_files_test/golden.md b/test/testdata/multiple_files_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+A direct dependency file of the input file.
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/multiple_rules_test/golden.md b/test/testdata/multiple_rules_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/namespace_test/golden.md b/test/testdata/namespace_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+A test that verifies documenting a namespace of functions.
+
 <a id="#my_namespace.assert_non_empty"></a>
 
 ## my_namespace.assert_non_empty

diff --git a/test/testdata/provider_basic_test/golden.md b/test/testdata/provider_basic_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#MyFooInfo"></a>
 
 ## MyFooInfo

diff --git a/test/testdata/providers_for_attributes_test/golden.md b/test/testdata/providers_for_attributes_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+The input file for the providers for attributes test
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/py_rule_test/golden.md b/test/testdata/py_rule_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+The input file for the python rule test
+
 <a id="#py_related_rule"></a>
 
 ## py_related_rule

diff --git a/test/testdata/repo_rules_test/golden.md b/test/testdata/repo_rules_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#my_repo"></a>
 
 ## my_repo

diff --git a/test/testdata/same_level_file_test/golden.md b/test/testdata/same_level_file_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/simple_test/golden.md b/test/testdata/simple_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#my_rule"></a>
 
 ## my_rule

diff --git a/test/testdata/struct_default_value_test/golden.md b/test/testdata/struct_default_value_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+The input file for struct default values test
+
 <a id="#check_struct_default_values"></a>
 
 ## check_struct_default_values

diff --git a/test/testdata/unknown_name_test/golden.md b/test/testdata/unknown_name_test/golden.md
@@ -1,5 +1,7 @@
 <!-- Generated with Stardoc: http://skydoc.bazel.build -->
 
+
+
 <a id="#my_rule_impl"></a>
 
 ## my_rule_impl