diff options
Diffstat (limited to 'test/testdata/angle_bracket_test/golden.md')
| -rwxr-xr-x[-rw-r--r--] | test/testdata/angle_bracket_test/golden.md | 56 |
1 files changed, 17 insertions, 39 deletions
diff --git a/test/testdata/angle_bracket_test/golden.md b/test/testdata/angle_bracket_test/golden.md index 06496b2..1c31dd2 100644..100755 --- a/test/testdata/angle_bracket_test/golden.md +++ b/test/testdata/angle_bracket_test/golden.md @@ -1,26 +1,19 @@ <!-- Generated with Stardoc: http://skydoc.bazel.build --> -Input file to test angle bracket bug (https://github.com/bazelbuild/skydoc/issues/186) +Input file to test <angle bracket bugs> -See https://github.com/bazelbuild/skydoc/issues/186, -https://github.com/bazelbuild/stardoc/issues/132, -and https://github.com/bazelbuild/stardoc/issues/137. - -<b>HTML formatting</b> can be used in docstrings, just as in regular Markdown. -Literal angle brackets can be obtained by escaping them with a backslash, where -the backslash itself must be escaped for use in a Starlark docstring -(`\\<` becomes \<), or by using HTML entities (`<` becomes <). -Angle brackets are also preserved in inline code blocks (`#include <vector>`). +See https://github.com/bazelbuild/skydoc/issues/186 +and https://github.com/bazelbuild/stardoc/issues/132 <a id="my_anglebrac"></a> ## my_anglebrac <pre> -my_anglebrac(<a href="#my_anglebrac-name">name</a>, <a href="#my_anglebrac-also_useless">also_useless</a>, <a href="#my_anglebrac-useless">useless</a>) +my_anglebrac(<a href="#my_anglebrac-name">name</a>, <a href="#my_anglebrac-useless">useless</a>) </pre> -Rule with \<brackets> +Rule with <brackets> **ATTRIBUTES** @@ -28,8 +21,7 @@ Rule with \<brackets> | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | <a id="my_anglebrac-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | | -| <a id="my_anglebrac-also_useless"></a>also_useless | Args with some formatted tags: `<tag>` and <pre><code class="language-xml"><tag2>x</tag2></code></pre> | String | optional | `"1<<5"` | -| <a id="my_anglebrac-useless"></a>useless | Args with some tags: \<tag1>, \<tag2> | String | optional | `"Find \\<brackets>"` | +| <a id="my_anglebrac-useless"></a>useless | Args with some tags: <tag1>, <tag2> | String | optional | <code>"Find <brackets>"</code> | <a id="bracketuse"></a> @@ -40,14 +32,14 @@ Rule with \<brackets> bracketuse(<a href="#bracketuse-foo">foo</a>, <a href="#bracketuse-bar">bar</a>, <a href="#bracketuse-baz">baz</a>) </pre> -Information with \<brackets> +Information with <brackets> **FIELDS** | Name | Description | | :------------- | :------------- | -| <a id="bracketuse-foo"></a>foo | A string representing \<foo> | +| <a id="bracketuse-foo"></a>foo | A string representing <foo> | | <a id="bracketuse-bar"></a>bar | A string representing bar | | <a id="bracketuse-baz"></a>baz | A string representing baz | @@ -57,19 +49,12 @@ Information with \<brackets> ## bracket_function <pre> -bracket_function(<a href="#bracket_function-param">param</a>, <a href="#bracket_function-md_string">md_string</a>) +bracket_function(<a href="#bracket_function-param">param</a>) </pre> -Dummy docstring with \<brackets>. - -This rule runs checks on `<angle brackets>`. +Dummy docstring with <brackets>. -Sometimes, we have such things on their own, but they may -also appear in code blocks, like - -```starlark -foo = "<thing>" -``` +This rule runs checks on <angle brackets>. **PARAMETERS** @@ -77,16 +62,15 @@ foo = "<thing>" | Name | Description | Default Value | | :------------- | :------------- | :------------- | -| <a id="bracket_function-param"></a>param | an arg with **formatted** docstring, `<default>` by default. | `"<default>"` | -| <a id="bracket_function-md_string"></a>md_string | A markdown string. | ``"foo `1<<10` bar"`` | +| <a id="bracket_function-param"></a>param | an arg with **formatted** docstring, <default> by default. | <code>"<default>"</code> | **RETURNS** -some \<angled> brackets +some <angled> brackets **DEPRECATED** -deprecated for \<reasons> as well as `<reasons>`. +deprecated for <reasons> <a id="bracket_aspect"></a> @@ -97,13 +81,7 @@ deprecated for \<reasons> as well as `<reasons>`. bracket_aspect(<a href="#bracket_aspect-name">name</a>, <a href="#bracket_aspect-brackets">brackets</a>) </pre> -Aspect. - -Sometimes, we want a code block like -```starlark -foo = "<brackets>" -``` -which includes angle brackets. +Aspect with <brackets> **ASPECT ATTRIBUTES** @@ -118,7 +96,7 @@ which includes angle brackets. | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | -| <a id="bracket_aspect-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | | -| <a id="bracket_aspect-brackets"></a>brackets | Attribute with \<brackets> | String | optional | `"<default>"` | +| <a id="bracket_aspect-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | | +| <a id="bracket_aspect-brackets"></a>brackets | Attribute with <brackets> | String | optional | <code>"<default>"</code> | |