updated stardoc.bzl documentation to fix rendering errors
diff --git a/docs/stardoc_rule.md b/docs/stardoc_rule.md index b6d0091..3b66271 100644 --- a/docs/stardoc_rule.md +++ b/docs/stardoc_rule.md
@@ -30,26 +30,8 @@ | provider_template | The input file template for generating documentation of providers. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | | renderer | The location of the renderer tool. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | | rule_template | The input file template for generating documentation of rules. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | -| semantic_flags | A list of canonical flags to affect Starlark semantics for the Starlark interpretter<br>during documentation generation. This should only be used to maintain compatibility with<br>non-default semantic flags required to use the given Starlark symbols.<br><br><br>For example, if <code>//foo:bar.bzl</code> does not build except when a user would specify<br><code>--incompatible_foo_semantic=false</code>, then this attribute should contain<br>"--incompatible_foo_semantic=false". | List of strings | optional | +| semantic_flags | A list of canonical flags to affect Starlark semantics for the Starlark interpretter<br>during documentation generation. This should only be used to maintain compatibility with<br>non-default semantic flags required to use the given Starlark symbols.<br><br>For example, if <code>//foo:bar.bzl</code> does not build except when a user would specify<br><code>--incompatible_foo_semantic=false</code>, then this attribute should contain<br>"--incompatible_foo_semantic=false". | List of strings | optional | | stardoc | The location of the stardoc tool. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | optional | | symbol_names | A list of symbol names to generate documentation for. These should correspond to<br>the names of rule definitions in the input file. If this list is empty, then<br>documentation for all exported rule definitions will be generated. | List of strings | optional | -<a name="#_stardoc_impl"></a> - -## _stardoc_impl - -<pre> -_stardoc_impl(<a href="#_stardoc_impl-ctx">ctx</a>) -</pre> - -Implementation of the stardoc rule. - -**PARAMETERS** - - -| Name | Description | Default Value | -| :-------------: | :-------------: | :-------------: | -| ctx | <p align="center"> - </p> | none | - -
diff --git a/stardoc/BUILD b/stardoc/BUILD index 115d983..a67873e 100644 --- a/stardoc/BUILD +++ b/stardoc/BUILD
@@ -32,7 +32,6 @@ input = ":stardoc.bzl", symbol_names = [ "stardoc", - "_stardoc_impl", ], deps = [":stardoc_lib"], )
diff --git a/stardoc/stardoc.bzl b/stardoc/stardoc.bzl index 0094b2c..a1f461f 100644 --- a/stardoc/stardoc.bzl +++ b/stardoc/stardoc.bzl
@@ -145,8 +145,9 @@ A list of canonical flags to affect Starlark semantics for the Starlark interpretter during documentation generation. This should only be used to maintain compatibility with non-default semantic flags required to use the given Starlark symbols. -<br><br>For example, if <code>//foo:bar.bzl</code> does not build except when a user would specify -<code>--incompatible_foo_semantic=false</code>, then this attribute should contain + +For example, if `//foo:bar.bzl` does not build except when a user would specify +`--incompatible_foo_semantic=false`, then this attribute should contain "--incompatible_foo_semantic=false". """, default = [],