aboutsummaryrefslogtreecommitdiff
path: root/test/testdata/input_template_test/golden.md
blob: 90e9a5dd0a76c644a29d0b1bdcafb7a21d63dc8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<!-- THIS HEADER IS FOR input_template_test ONLY -->

Module Docstring: "Input file for input template test"

<a id="#my_example"></a>

## my_example

<pre>
my_example(<a href="#my_example-name">name</a>, <a href="#my_example-useless">useless</a>)
</pre>

Small example of rule using chosen template.

<b>input_template_test BOLD ATTRIBUTES</b>

### Attributes


<b>
      <code>name</code>
        <a href="https://bazel.build/concepts/labels#target-names">Name</a>; required
</b>
        <p>
          A unique name for this target.
        </p>
<b>
      <code>useless</code>
        String; optional
</b>
        <p>
          This argument will be ignored.
        </p>


<a id="#example"></a>

## example

<pre>
example(<a href="#example-foo">foo</a>, <a href="#example-bar">bar</a>, <a href="#example-baz">baz</a>)
</pre>

Stores information about an example in chosen template.

<b>input_template_test BOLD FIELDS</b>

### Fields

<b>
      <code>foo</code>
</b>
        <p>A string representing foo</p>
<b>
      <code>bar</code>
</b>
        <p>A string representing bar</p>
<b>
      <code>baz</code>
</b>
        <p>A string representing baz</p>


<a id="#my_aspect_impl"></a>

## my_aspect_impl

<pre>
my_aspect_impl(<a href="#my_aspect_impl-ctx">ctx</a>)
</pre>



<b>input_template_test BOLD PARAMETERS</b>

### Parameters

<b>
      <code>ctx</code>
        required.

<a id="#template_function"></a>

## template_function

<pre>
template_function(<a href="#template_function-foo">foo</a>)
</pre>

Runs some checks on the given function parameter.

This rule runs checks on a given function parameter in chosen template.
Use `bazel build` to run the check.


<b>input_template_test BOLD PARAMETERS</b>

### Parameters

<b>
      <code>foo</code>
        required.        <p>
          A unique name for this function.
        </p>


<a id="#my_aspect"></a>

## my_aspect

<pre>
my_aspect(<a href="#my_aspect-name">name</a>, <a href="#my_aspect-first">first</a>)
</pre>

This is my aspect. It does stuff.

### Aspect Attributes

        deps
        String; required.
        attr_aspect
        String; required.

### Attributes

<b>
      <code>name</code>
        <a href="https://bazel.build/concepts/labels#target-names">Name</a>; required
</b>
        <p>
          A unique name for this target.
        </p>
<b>
      <code>first</code>
        <a href="https://bazel.build/concepts/labels">Label</a>; required
</b>