unplugged-system/external/stardoc/test/testdata/angle_bracket_test/golden.md

2.6 KiB
Executable File

Input file to test <angle bracket bugs>

See https://github.com/bazelbuild/skydoc/issues/186 and https://github.com/bazelbuild/stardoc/issues/132

my_anglebrac

my_anglebrac(name, useless)

Rule with <brackets>

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
useless Args with some tags: <tag1>, <tag2> String optional "Find <brackets>"

bracketuse

bracketuse(foo, bar, baz)

Information with <brackets>

FIELDS

Name Description
foo A string representing <foo>
bar A string representing bar
baz A string representing baz

bracket_function

bracket_function(param)

Dummy docstring with <brackets>.

This rule runs checks on <angle brackets>.

PARAMETERS

Name Description Default Value
param an arg with formatted docstring, <default> by default. "<default>"

RETURNS

some <angled> brackets

DEPRECATED

deprecated for <reasons>

bracket_aspect

bracket_aspect(name, brackets)

Aspect with <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>"