Input file to test angle bracket bug (https://github.com/bazelbuild/skydoc/issues/186)
See https://github.com/bazelbuild/skydoc/issues/186, https://github.com/bazelbuild/stardoc/issues/132, and https://github.com/bazelbuild/stardoc/issues/137.
HTML formatting 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>
).
Rule with <brackets>
ATTRIBUTES
Name | Description | Type | Mandatory | Default |
---|---|---|---|---|
name | A unique name for this target. | Name | required | |
also_useless | Args with some formatted tags: <tag> and <tag2>x</tag2> | String | optional | "1<<5" |
useless | Args with some tags: <tag1>, <tag2> | String | optional | "Find \\<brackets>" |
Information with <brackets>
FIELDS
Name | Description |
---|---|
foo | A string representing <foo> |
bar | A string representing bar |
baz | A string representing baz |
Dummy docstring with <brackets>.
This rule runs checks on <angle brackets>
.
Sometimes, we have such things on their own, but they may also appear in code blocks, like
foo = "<thing>"
PARAMETERS
Name | Description | Default Value |
---|---|---|
param | an arg with formatted docstring, <default> by default. | "<default>" |
md_string | A markdown string. | "foo `1<<10` bar" |
RETURNS
some <angled> brackets
DEPRECATED
deprecated for <reasons> as well as <reasons>
.
Aspect.
Sometimes, we want a code block like
foo = "<brackets>"
which includes angle brackets.
ASPECT ATTRIBUTES
Name | Type |
---|---|
deps | String |
ATTRIBUTES
Name | Description | Type | Mandatory | Default |
---|---|---|---|---|
name | A unique name for this target. | Name | required | |
brackets | Attribute with <brackets> | String | optional | "<default>" |