Skip to content

Commit 7a96295

Browse files
committed
reformat mech docs and add anchors
1 parent eeb647d commit 7a96295

File tree

10 files changed

+46
-51
lines changed

10 files changed

+46
-51
lines changed

docs/mechs/accelerometers.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,17 @@ For
3232
[conditional events](../events/overview/conditional.md), the prefix for accelerometers is
3333
`device.accelerometers.(name)`.
3434

35-
*value*
35+
### *value*:
3636

37-
: A three-item tuple (x, y, z) of the current accelerometer values.
37+
A three-item tuple (x, y, z) of the current accelerometer values.
3838

3939
## Related How To guides
4040

4141
[Help us to write it](../about/help.md)
4242

4343
## Related Events
4444

45-
*None*
45+
### *None*:
4646

47-
: Varies based on the configured (you can configure events to be
48-
emitted when certain G-force thresholds are exceeded).
47+
Varies based on the configured (you can configure events to be
48+
emitted when certain G-force thresholds are exceeded).

docs/mechs/autofire_coils.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -207,10 +207,9 @@ For
207207
[dynamic values](../config/instructions/dynamic_values.md) and
208208
[conditional events](../events/overview/conditional.md), the prefix for autofire coils is `device.autofires.(name)`.
209209

210-
*enabled*
210+
### *enabled*:
211211

212-
: Boolean (true/false) which shows whether this autofire coil is
213-
enabled.
212+
Boolean (true/false) which shows whether this autofire coil is enabled.
214213

215214
## Fully working basic example
216215

@@ -306,7 +305,6 @@ A few comments on the above example:
306305

307306
## Related Events
308307

309-
*None*
308+
### *None*:
310309

311-
: The autofire coils can be configured to enable or disable based on
312-
other events.
310+
The autofire coils can be configured to enable or disable based on other events.

docs/mechs/ball_devices/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -119,19 +119,19 @@ For
119119
[conditional events](../../events/overview/conditional.md), the prefix for ball devices is
120120
`device.ball_devices.(name)`.
121121

122-
*available_balls*
122+
### *available_balls*:
123123

124-
: Number of balls that are available to be ejected. This differs from
125-
*balls* since it's possible that this device could have balls that
126-
are being used for some other eject, and thus not available.
124+
Number of balls that are available to be ejected. This differs from
125+
*balls* since it's possible that this device could have balls that
126+
are being used for some other eject, and thus not available.
127127

128-
*state*
128+
### *state*:
129129

130-
: What state this device is in.
130+
What state this device is in.
131131

132-
*balls*
132+
### *balls*:
133133

134-
: How many balls this device is currently holding.
134+
How many balls this device is currently holding.
135135

136136
## Related How To guides
137137

docs/mechs/diverters/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -176,20 +176,20 @@ For
176176
[dynamic values](../../config/instructions/dynamic_values.md) and
177177
[conditional events](../../events/overview/conditional.md), the prefix for diverters is `device.diverters.(name)`.
178178

179-
*active*
179+
### *active*:
180180

181-
: Boolean (true/false) as to whether this diverter is actively on and
182-
in the powered state.
181+
Boolean (true/false) as to whether this diverter is actively on and
182+
in the powered state.
183183

184-
*enabled*
184+
### *enabled*:
185185

186-
: Boolean (true/false) as to whether this diverter is enabled (meaning
187-
it will be activated when a ball approaches it).
186+
Boolean (true/false) as to whether this diverter is enabled (meaning
187+
it will be activated when a ball approaches it).
188188

189-
*eject_state*
189+
### *eject_state*:
190190

191-
: Boolean (true/false) which shows whether this diverter will be
192-
activating to route a ball eject from an upstream ball device.
191+
Boolean (true/false) which shows whether this diverter will be
192+
activating to route a ball eject from an upstream ball device.
193193

194194
## Related How To guides
195195

docs/mechs/flippers/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ For
9797
[dynamic values](../../config/instructions/dynamic_values.md) and
9898
[conditional events](../../events/overview/conditional.md), the prefix for flippers is `device.flippers.(name)`.
9999

100-
*enabled*
100+
### *enabled*:
101101

102-
: Boolean (true/false) which shows whether this ball hold is enabled.
102+
Boolean (true/false) which shows whether this ball hold is enabled.
103103

104104
## Related How To guides
105105

docs/mechs/kickbacks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ For
4646
[dynamic values](../config/instructions/dynamic_values.md) and
4747
[conditional events](../events/overview/conditional.md), the prefix for kickbacks is `device.kickbacks.(name)`.
4848

49-
*enabled*
49+
### *enabled*:
5050

51-
: Boolean (true/false) which shows whether this kickback is enabled.
51+
Boolean (true/false) which shows whether this kickback is enabled.
5252

5353
## Related Events
5454

docs/mechs/lights/gis.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,11 @@ For
104104
[dynamic values](../../config/instructions/dynamic_values.md) and
105105
[conditional events](../../events/overview/conditional.md), the prefix for lights is `device.lights.(name)`.
106106

107-
*color*
107+
### *color*:
108108

109-
: The color of this string. If you set it to brightness values all
110-
color channels will have the same value. Brightness 100 (of 255)
111-
will be hex 64 and color 646464.
109+
The color of this string. If you set it to brightness values all
110+
color channels will have the same value. Brightness 100 (of 255)
111+
will be hex 64 and color 646464.
112112

113113
## Related How To guides
114114

docs/mechs/magnets/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,13 @@ For
9595
[dynamic values](../../config/instructions/dynamic_values.md) and
9696
[conditional events](../../events/overview/conditional.md), the prefix for magnets is `device.magnets.(name)`.
9797

98-
*active*
98+
### *active*:
9999

100-
: Boolean (true/false) as to whether this magnet is actively on and in
101-
the powered state.
100+
Boolean (true/false) as to whether this magnet is actively on and in the powered state.
102101

103-
*enabled*
102+
### *enabled*:
104103

105-
: Boolean (true/false) which shows whether this ball hold is enabled.
104+
Boolean (true/false) which shows whether this ball hold is enabled.
106105

107106
## Related How To guides
108107

docs/mechs/servos/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,9 @@ For
4949
[dynamic values](../../config/instructions/dynamic_values.md) and
5050
[conditional events](../../events/overview/conditional.md), the prefix for servos is `device.servos.(name)`.
5151

52-
*position*
52+
### *position*:
5353

54-
: Value, stored in memory of what servo position should be, on a scale
55-
from 0.0 to 1.0.
54+
Value, stored in memory of what servo position should be, on a scale from 0.0 to 1.0.
5655

5756
Related How To guides:
5857

docs/mechs/targets/drop_targets/drop_target_bank.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,17 @@ For
5151
[conditional events](../../../events/overview/conditional.md), the prefix for drop target banks is
5252
`device.drop_target_banks.(name)`.
5353

54-
*complete*
54+
### *complete*:
5555

56-
: Boolean (true/false) which shows whether every target in this bank
57-
is complete (down).
56+
Boolean (true/false) which shows whether every target in this bank is complete (down).
5857

59-
*down*
58+
### *down*:
6059

61-
: Number of drop targets in the bank that are in the down state.
60+
Number of drop targets in the bank that are in the down state.
6261

63-
*up*
62+
### *up*:
6463

65-
: Number of drop targets in the bank that are in the up state.
64+
Number of drop targets in the bank that are in the up state.
6665

6766
## Related How To guides
6867

0 commit comments

Comments
 (0)