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 (&lt; becomes <). Angle brackets are also preserved in inline code blocks (#include <vector>).

my_anglebrac

Rule with <brackets>

ATTRIBUTES

NameDescriptionTypeMandatoryDefault
nameA unique name for this target.Namerequired
also_uselessArgs with some formatted tags: <tag> and <tag2>x</tag2>Stringoptional"1<<5"
uselessArgs with some tags: <tag1>, <tag2>Stringoptional"Find \<brackets>"

bracketuse

Information with <brackets>

FIELDS

NameDescription
fooA string representing <foo>
barA string representing bar
bazA string representing baz

bracket_function

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

NameDescriptionDefault Value
paraman arg with formatted docstring, <default> by default."<default>"
md_stringA markdown string."foo `1<<10` bar"

RETURNS

some <angled> brackets

DEPRECATED

deprecated for <reasons> as well as <reasons>.

bracket_aspect

Aspect.

Sometimes, we want a code block like

foo = "<brackets>"

which includes angle brackets.

ASPECT ATTRIBUTES

NameType
depsString

ATTRIBUTES

NameDescriptionTypeMandatoryDefault
nameA unique name for this target.Namerequired
bracketsAttribute with <brackets>Stringoptional"<default>"