From 4d5b5dae64af3b445c73612e09371a6c0e7fd4fd Mon Sep 17 00:00:00 2001 From: Brian Silverman Date: Mon, 7 Mar 2022 13:00:28 -0800 Subject: [PATCH] Fix the generated links to things with CamelCase names (#124) --- docs/stardoc_rule.md | 2 +- stardoc/templates/html_tables/aspect.vm | 2 +- stardoc/templates/html_tables/func.vm | 2 +- stardoc/templates/html_tables/provider.vm | 2 +- stardoc/templates/html_tables/rule.vm | 2 +- stardoc/templates/markdown_tables/aspect.vm | 2 +- stardoc/templates/markdown_tables/func.vm | 2 +- stardoc/templates/markdown_tables/provider.vm | 2 +- stardoc/templates/markdown_tables/rule.vm | 2 +- test/testdata/android_basic_test/golden.md | 2 +- test/testdata/angle_bracket_test/golden.md | 6 +++--- test/testdata/apple_basic_test/golden.md | 2 +- test/testdata/aspect_test/golden.md | 6 +++--- test/testdata/attribute_defaults_test/golden.md | 4 ++-- test/testdata/attribute_types_test/golden.md | 2 +- test/testdata/cc_api_test/golden.md | 6 +++--- test/testdata/config_apis_test/golden.md | 8 ++++---- test/testdata/cpp_basic_test/golden.md | 2 +- test/testdata/filter_rules_test/golden.md | 4 ++-- test/testdata/function_basic_test/golden.md | 8 ++++---- test/testdata/generated_bzl_test/golden.md | 2 +- test/testdata/html_tables_template_test/golden.md | 8 ++++---- test/testdata/java_basic_test/golden.md | 2 +- test/testdata/local_repository_test/golden.md | 2 +- test/testdata/macro_kwargs_test/golden.md | 6 +++--- test/testdata/misc_apis_test/golden.md | 8 ++++---- test/testdata/multi_level_namespace_test/golden.md | 10 +++++----- .../golden.md | 6 +++--- test/testdata/multiple_files_test/golden.md | 8 ++++---- test/testdata/multiple_rules_test/golden.md | 8 ++++---- test/testdata/namespace_test/golden.md | 6 +++--- test/testdata/provider_basic_test/golden.md | 6 +++--- test/testdata/providers_for_attributes_test/golden.md | 8 ++++---- test/testdata/py_rule_test/golden.md | 2 +- test/testdata/repo_rules_test/golden.md | 2 +- test/testdata/same_level_file_test/golden.md | 2 +- test/testdata/simple_test/golden.md | 2 +- test/testdata/struct_default_value_test/golden.md | 2 +- test/testdata/unknown_name_test/golden.md | 2 +- 39 files changed, 80 insertions(+), 80 deletions(-) diff --git a/docs/stardoc_rule.md b/docs/stardoc_rule.md index 8c55ef2e..b3e3b115 100644 --- a/docs/stardoc_rule.md +++ b/docs/stardoc_rule.md @@ -2,7 +2,7 @@ Starlark rule for stardoc: a documentation generator tool written in Java. - + ## stardoc diff --git a/stardoc/templates/html_tables/aspect.vm b/stardoc/templates/html_tables/aspect.vm index c930cef6..e66b2b29 100644 --- a/stardoc/templates/html_tables/aspect.vm +++ b/stardoc/templates/html_tables/aspect.vm @@ -1,4 +1,4 @@ - + #[[##]]# ${aspectName} diff --git a/stardoc/templates/html_tables/func.vm b/stardoc/templates/html_tables/func.vm index 3162beb9..b52e5bca 100644 --- a/stardoc/templates/html_tables/func.vm +++ b/stardoc/templates/html_tables/func.vm @@ -1,4 +1,4 @@ - + #[[##]]# ${funcInfo.functionName} diff --git a/stardoc/templates/html_tables/provider.vm b/stardoc/templates/html_tables/provider.vm index 9156b10c..b1820d56 100644 --- a/stardoc/templates/html_tables/provider.vm +++ b/stardoc/templates/html_tables/provider.vm @@ -1,4 +1,4 @@ - + #[[##]]# ${providerName} diff --git a/stardoc/templates/html_tables/rule.vm b/stardoc/templates/html_tables/rule.vm index 2158ffa6..0d5b6382 100644 --- a/stardoc/templates/html_tables/rule.vm +++ b/stardoc/templates/html_tables/rule.vm @@ -1,4 +1,4 @@ - + #[[##]]# ${ruleName} diff --git a/stardoc/templates/markdown_tables/aspect.vm b/stardoc/templates/markdown_tables/aspect.vm index 6c13846f..04cd9757 100644 --- a/stardoc/templates/markdown_tables/aspect.vm +++ b/stardoc/templates/markdown_tables/aspect.vm @@ -1,4 +1,4 @@ - + #[[##]]# ${aspectName} diff --git a/stardoc/templates/markdown_tables/func.vm b/stardoc/templates/markdown_tables/func.vm index 2ac9fe6a..d66db69f 100644 --- a/stardoc/templates/markdown_tables/func.vm +++ b/stardoc/templates/markdown_tables/func.vm @@ -1,4 +1,4 @@ - + #[[##]]# ${funcInfo.functionName} diff --git a/stardoc/templates/markdown_tables/provider.vm b/stardoc/templates/markdown_tables/provider.vm index ad8e3ee7..0a866dbb 100644 --- a/stardoc/templates/markdown_tables/provider.vm +++ b/stardoc/templates/markdown_tables/provider.vm @@ -1,4 +1,4 @@ - + #[[##]]# ${providerName} diff --git a/stardoc/templates/markdown_tables/rule.vm b/stardoc/templates/markdown_tables/rule.vm index 47532994..d2ba6c25 100644 --- a/stardoc/templates/markdown_tables/rule.vm +++ b/stardoc/templates/markdown_tables/rule.vm @@ -1,4 +1,4 @@ - + #[[##]]# ${ruleName} diff --git a/test/testdata/android_basic_test/golden.md b/test/testdata/android_basic_test/golden.md index 465e5815..15ecb87f 100755 --- a/test/testdata/android_basic_test/golden.md +++ b/test/testdata/android_basic_test/golden.md @@ -2,7 +2,7 @@ - + ## android_related_rule diff --git a/test/testdata/angle_bracket_test/golden.md b/test/testdata/angle_bracket_test/golden.md index 04e15d64..525a5b26 100755 --- a/test/testdata/angle_bracket_test/golden.md +++ b/test/testdata/angle_bracket_test/golden.md @@ -2,7 +2,7 @@ Input file to test angle bracket bug (https://github.com/bazelbuild/skydoc/issues/186) - + ## my_anglebrac @@ -21,7 +21,7 @@ Rule with | useless | Args with some tags: <tag1>, <tag2> | String | optional | "Find " | - + ## bracketuse @@ -41,7 +41,7 @@ Information with | baz | A string representing baz | - + ## bracket_function diff --git a/test/testdata/apple_basic_test/golden.md b/test/testdata/apple_basic_test/golden.md index 15b38d82..20e29170 100755 --- a/test/testdata/apple_basic_test/golden.md +++ b/test/testdata/apple_basic_test/golden.md @@ -2,7 +2,7 @@ - + ## apple_related_rule diff --git a/test/testdata/aspect_test/golden.md b/test/testdata/aspect_test/golden.md index e5fd51b6..e106af72 100755 --- a/test/testdata/aspect_test/golden.md +++ b/test/testdata/aspect_test/golden.md @@ -2,7 +2,7 @@ The input file for the aspect test - + ## my_aspect_impl @@ -20,7 +20,7 @@ my_aspect_impl(ctx) | ctx |

-

| none | - + ## my_aspect @@ -49,7 +49,7 @@ This is my aspect. It does stuff. | second | - | Dictionary: String -> String | required | | - + ## other_aspect diff --git a/test/testdata/attribute_defaults_test/golden.md b/test/testdata/attribute_defaults_test/golden.md index b1a59da6..ecb721c4 100755 --- a/test/testdata/attribute_defaults_test/golden.md +++ b/test/testdata/attribute_defaults_test/golden.md @@ -2,7 +2,7 @@ A golden test to verify attribute default values. - + ## my_rule @@ -43,7 +43,7 @@ This is my rule. It does stuff. | w | - | Integer | optional | 0 | - + ## my_aspect diff --git a/test/testdata/attribute_types_test/golden.md b/test/testdata/attribute_types_test/golden.md index 03fa6262..0b6501f0 100755 --- a/test/testdata/attribute_types_test/golden.md +++ b/test/testdata/attribute_types_test/golden.md @@ -2,7 +2,7 @@ - + ## my_rule diff --git a/test/testdata/cc_api_test/golden.md b/test/testdata/cc_api_test/golden.md index e7644bd1..4105ca38 100755 --- a/test/testdata/cc_api_test/golden.md +++ b/test/testdata/cc_api_test/golden.md @@ -2,7 +2,7 @@ Input file for C++ api test - + ## cpp_related_rule @@ -24,7 +24,7 @@ This rule does C++-related things. | third | - | Label | required | | - + ## exercise_the_api @@ -36,7 +36,7 @@ exercise_the_api() - + ## my_rule_impl diff --git a/test/testdata/config_apis_test/golden.md b/test/testdata/config_apis_test/golden.md index b2129524..b1e5d8a6 100755 --- a/test/testdata/config_apis_test/golden.md +++ b/test/testdata/config_apis_test/golden.md @@ -2,7 +2,7 @@ - + ## int_setting @@ -20,7 +20,7 @@ An integer flag. | name | A unique name for this target. | Name | required | | - + ## string_flag @@ -38,7 +38,7 @@ A string flag. | name | A unique name for this target. | Name | required | | - + ## exercise_the_api @@ -50,7 +50,7 @@ exercise_the_api() - + ## transition_func diff --git a/test/testdata/cpp_basic_test/golden.md b/test/testdata/cpp_basic_test/golden.md index b5c2e208..090c2d62 100755 --- a/test/testdata/cpp_basic_test/golden.md +++ b/test/testdata/cpp_basic_test/golden.md @@ -2,7 +2,7 @@ - + ## cpp_related_rule diff --git a/test/testdata/filter_rules_test/golden.md b/test/testdata/filter_rules_test/golden.md index 82448fc1..770564e6 100755 --- a/test/testdata/filter_rules_test/golden.md +++ b/test/testdata/filter_rules_test/golden.md @@ -2,7 +2,7 @@ - + ## my_rule @@ -22,7 +22,7 @@ This is my rule. It does stuff. | second | - | Dictionary: String -> String | required | | - + ## whitelisted_dep_rule diff --git a/test/testdata/function_basic_test/golden.md b/test/testdata/function_basic_test/golden.md index 4bd5e0e3..138f3c2f 100755 --- a/test/testdata/function_basic_test/golden.md +++ b/test/testdata/function_basic_test/golden.md @@ -2,7 +2,7 @@ A test that verifies basic user function documentation. - + ## check_sources @@ -32,7 +32,7 @@ Use `bazel build` to run the check. | struct_param |

-

| struct(foo = "bar") | - + ## deprecated_do_not_use @@ -48,7 +48,7 @@ This function is deprecated. Use literally anything but this function. - + ## returns_a_thing @@ -70,7 +70,7 @@ Returns a suffixed name. A suffixed version of the name. - + ## undocumented_function diff --git a/test/testdata/generated_bzl_test/golden.md b/test/testdata/generated_bzl_test/golden.md index a05af556..7562a55e 100755 --- a/test/testdata/generated_bzl_test/golden.md +++ b/test/testdata/generated_bzl_test/golden.md @@ -2,7 +2,7 @@ A direct dependency file of the input file. - + ## my_rule diff --git a/test/testdata/html_tables_template_test/golden.md b/test/testdata/html_tables_template_test/golden.md index fbec191d..b24fb2a8 100755 --- a/test/testdata/html_tables_template_test/golden.md +++ b/test/testdata/html_tables_template_test/golden.md @@ -2,7 +2,7 @@ Input file for markdown template test - + ## example_rule @@ -58,7 +58,7 @@ String; optional - + ## ExampleProviderInfo @@ -110,7 +110,7 @@ A string representing baz - + ## example_function @@ -159,7 +159,7 @@ This parameter does bar related things. - + ## example_aspect diff --git a/test/testdata/java_basic_test/golden.md b/test/testdata/java_basic_test/golden.md index 5b8f4cda..78e6b2e6 100755 --- a/test/testdata/java_basic_test/golden.md +++ b/test/testdata/java_basic_test/golden.md @@ -2,7 +2,7 @@ - + ## java_related_rule diff --git a/test/testdata/local_repository_test/golden.md b/test/testdata/local_repository_test/golden.md index 9dd924b1..d06bf71e 100755 --- a/test/testdata/local_repository_test/golden.md +++ b/test/testdata/local_repository_test/golden.md @@ -2,7 +2,7 @@ A test that verifies documenting functions in an input file under a local_repository. - + ## min diff --git a/test/testdata/macro_kwargs_test/golden.md b/test/testdata/macro_kwargs_test/golden.md index 1e5ff6dc..d2af867c 100755 --- a/test/testdata/macro_kwargs_test/golden.md +++ b/test/testdata/macro_kwargs_test/golden.md @@ -2,7 +2,7 @@ Tests for functions which use *args or **kwargs - + ## macro_with_args @@ -25,7 +25,7 @@ My args macro is OK. An empty list. - + ## macro_with_both @@ -53,7 +53,7 @@ Not much else to say. An empty list. - + ## macro_with_kwargs diff --git a/test/testdata/misc_apis_test/golden.md b/test/testdata/misc_apis_test/golden.md index cf3169c4..c8e98e33 100755 --- a/test/testdata/misc_apis_test/golden.md +++ b/test/testdata/misc_apis_test/golden.md @@ -2,7 +2,7 @@ - + ## my_rule @@ -25,7 +25,7 @@ This rule exercises some of the build API. | tool | The location of the tool to use. | Label | optional | //foo/bar/baz:target | - + ## MyInfo @@ -44,7 +44,7 @@ MyInfo(foo, bar) | bar | Something bar-related. | - + ## exercise_the_api @@ -56,7 +56,7 @@ exercise_the_api() - + ## my_rule_impl diff --git a/test/testdata/multi_level_namespace_test/golden.md b/test/testdata/multi_level_namespace_test/golden.md index 21d7fb83..85791c9a 100755 --- a/test/testdata/multi_level_namespace_test/golden.md +++ b/test/testdata/multi_level_namespace_test/golden.md @@ -2,7 +2,7 @@ A test that verifies documenting a multi-leveled namespace of functions. - + ## my_namespace.min @@ -24,7 +24,7 @@ Returns the minimum of given elements. The minimum integer in the given list. - + ## my_namespace.math.min @@ -46,7 +46,7 @@ Returns the minimum of given elements. The minimum integer in the given list. - + ## my_namespace.foo.bar.baz @@ -58,7 +58,7 @@ This function does nothing. - + ## my_namespace.one.two.min @@ -80,7 +80,7 @@ Returns the minimum of given elements. The minimum integer in the given list. - + ## my_namespace.one.three.does_nothing diff --git a/test/testdata/multi_level_namespace_test_with_whitelist/golden.md b/test/testdata/multi_level_namespace_test_with_whitelist/golden.md index 46f95928..1ca16086 100644 --- a/test/testdata/multi_level_namespace_test_with_whitelist/golden.md +++ b/test/testdata/multi_level_namespace_test_with_whitelist/golden.md @@ -4,7 +4,7 @@ A test that verifies documenting a multi-leveled namespace of functions with whi The whitelist symbols should cause everything in my_namespace to to be documented, but only a specific symbol in other_namespace to be documented. - + ## my_namespace.min @@ -22,7 +22,7 @@ Returns the minimum of given elements. | integers |

-

| none | - + ## my_namespace.math.min @@ -40,7 +40,7 @@ Returns the minimum of given elements. | integers |

-

| none | - + ## other_namespace.foo.nothing diff --git a/test/testdata/multiple_files_test/golden.md b/test/testdata/multiple_files_test/golden.md index e097ea19..8b23a862 100755 --- a/test/testdata/multiple_files_test/golden.md +++ b/test/testdata/multiple_files_test/golden.md @@ -2,7 +2,7 @@ A direct dependency file of the input file. - + ## my_rule @@ -22,7 +22,7 @@ This is my rule. It does stuff. | second | - | Dictionary: String -> String | required | | - + ## other_rule @@ -42,7 +42,7 @@ This is another rule. | third | third other_rule doc string | Label | required | | - + ## yet_another_rule @@ -61,7 +61,7 @@ This is yet another rule | fifth | - | Label | required | | - + ## top_fun diff --git a/test/testdata/multiple_rules_test/golden.md b/test/testdata/multiple_rules_test/golden.md index 5535326f..943e23f0 100755 --- a/test/testdata/multiple_rules_test/golden.md +++ b/test/testdata/multiple_rules_test/golden.md @@ -2,7 +2,7 @@ - + ## my_rule @@ -22,7 +22,7 @@ This is my rule. It does stuff. | second | - | Dictionary: String -> String | required | | - + ## other_rule @@ -42,7 +42,7 @@ This is another rule. | third | - | Label | required | | - + ## yet_another_rule @@ -61,7 +61,7 @@ This is yet another rule | fifth | - | Label | required | | - + ## my_rule_impl diff --git a/test/testdata/namespace_test/golden.md b/test/testdata/namespace_test/golden.md index a320caa3..f840fcf6 100755 --- a/test/testdata/namespace_test/golden.md +++ b/test/testdata/namespace_test/golden.md @@ -2,7 +2,7 @@ A test that verifies documenting a namespace of functions. - + ## my_namespace.assert_non_empty @@ -21,7 +21,7 @@ Asserts the two given lists are not empty. | other_list | The second list | none | - + ## my_namespace.min @@ -43,7 +43,7 @@ Returns the minimum of given elements. The minimum integer in the given list. - + ## my_namespace.join_strings diff --git a/test/testdata/provider_basic_test/golden.md b/test/testdata/provider_basic_test/golden.md index 4143e67a..a9d76bfc 100755 --- a/test/testdata/provider_basic_test/golden.md +++ b/test/testdata/provider_basic_test/golden.md @@ -2,7 +2,7 @@ - + ## MyFooInfo @@ -21,7 +21,7 @@ Stores information about a foo. | baz | (Undocumented) | - + ## MyPoorlyDocumentedInfo @@ -35,7 +35,7 @@ MyPoorlyDocumentedInfo() - + ## MyVeryDocumentedInfo diff --git a/test/testdata/providers_for_attributes_test/golden.md b/test/testdata/providers_for_attributes_test/golden.md index d25414f4..1010c3b8 100755 --- a/test/testdata/providers_for_attributes_test/golden.md +++ b/test/testdata/providers_for_attributes_test/golden.md @@ -2,7 +2,7 @@ The input file for the providers for attributes test - + ## my_rule @@ -26,7 +26,7 @@ This rule does things. | third | - | Label | optional | None | - + ## MyProviderInfo @@ -45,7 +45,7 @@ MyProviderInfo(foo, bar | Something bar-related. | - + ## OtherProviderInfo @@ -59,7 +59,7 @@ OtherProviderInfo() - + ## my_rule_impl diff --git a/test/testdata/py_rule_test/golden.md b/test/testdata/py_rule_test/golden.md index eebc7c93..e880191e 100755 --- a/test/testdata/py_rule_test/golden.md +++ b/test/testdata/py_rule_test/golden.md @@ -2,7 +2,7 @@ The input file for the python rule test - + ## py_related_rule diff --git a/test/testdata/repo_rules_test/golden.md b/test/testdata/repo_rules_test/golden.md index 9acbf0f6..3a13338a 100755 --- a/test/testdata/repo_rules_test/golden.md +++ b/test/testdata/repo_rules_test/golden.md @@ -2,7 +2,7 @@ - + ## my_repo diff --git a/test/testdata/same_level_file_test/golden.md b/test/testdata/same_level_file_test/golden.md index 7d9f0d2c..fe77121c 100755 --- a/test/testdata/same_level_file_test/golden.md +++ b/test/testdata/same_level_file_test/golden.md @@ -2,7 +2,7 @@ - + ## my_rule diff --git a/test/testdata/simple_test/golden.md b/test/testdata/simple_test/golden.md index 9492849f..70ede5d4 100755 --- a/test/testdata/simple_test/golden.md +++ b/test/testdata/simple_test/golden.md @@ -2,7 +2,7 @@ - + ## my_rule diff --git a/test/testdata/struct_default_value_test/golden.md b/test/testdata/struct_default_value_test/golden.md index 1260be5f..6d07214d 100755 --- a/test/testdata/struct_default_value_test/golden.md +++ b/test/testdata/struct_default_value_test/golden.md @@ -2,7 +2,7 @@ The input file for struct default values test - + ## check_struct_default_values diff --git a/test/testdata/unknown_name_test/golden.md b/test/testdata/unknown_name_test/golden.md index c5390d71..8bbe43c9 100755 --- a/test/testdata/unknown_name_test/golden.md +++ b/test/testdata/unknown_name_test/golden.md @@ -2,7 +2,7 @@ - + ## my_rule_impl