Skip to content

Commit 2eaa943

Browse files
use admonitions
1 parent c2d069e commit 2eaa943

File tree

4 files changed

+26
-19
lines changed

4 files changed

+26
-19
lines changed

src/i2c.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -635,10 +635,10 @@ o I2C on any pair of spare GPIO
635635
Returns 0 if OK, otherwise `PiGPIO.PI_BAD_USER_GPIO`, `PiGPIO.PI_BAD_I2C_BAUD`,
636636
or `PiGPIO.PI_GPIO_IN_USE`.
637637
638-
NOTE
638+
!!! note
639639
640-
The GPIO used for SDA and SCL must have pull-ups to 3V3 connected.
641-
As a guide the hardware pull-ups on pins 3 and 5 are 1k8 in value.
640+
The GPIO used for SDA and SCL must have pull-ups to 3V3 connected.
641+
As a guide the hardware pull-ups on pins 3 and 5 are 1k8 in value.
642642
643643
```julia
644644
h = bb_i2c_open(pi, 4, 5, 50000) # bit bang on GPIO 4/5 at 50kbps

src/pi.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,8 +1010,9 @@ end
10101010
Starts hardware PWM on a GPIO at the specified frequency
10111011
and dutycycle. Frequencies above 30MHz are unlikely to work.
10121012
1013-
NOTE: Any waveform started by `wave_send_once`,
1014-
`wave_send_repeat`, or `wave_chain` will be cancelled.
1013+
!!! note
1014+
Any waveform started by `wave_send_once`, `wave_send_repeat`, or
1015+
`wave_chain` will be cancelled.
10151016
10161017
This function is only valid if the pigpio main clock is PCM.
10171018
The main clock defaults to PCM but may be overridden when the

src/spiSerial.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ b b b b b b R T n n n n W A u2 u1 u0 p2 p1 p0 m m
2727
2828
mm defines the SPI mode.
2929
30-
WARNING: modes 1 and 3 do not appear to work on
31-
the auxiliary device.
30+
!!! warning
31+
32+
modes 1 and 3 do not appear to work on the auxiliary device.
3233
3334
. .
3435
Mode POL PHA

src/wave.jl

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,9 @@ end
242242
Transmits the waveform with id wave_id. The waveform is sent
243243
once.
244244
245-
NOTE: Any hardware PWM started by `hardware_PWM` will
246-
be cancelled.
245+
!!! note
246+
247+
Any hardware PWM started by `hardware_PWM` will be cancelled.
247248
248249
* `wave_id`: >=0 (as returned by a prior call to `wave_create`).
249250
@@ -258,12 +259,14 @@ function wave_send_once(self::Pi, wave_id)
258259
end
259260

260261
"""
261-
Transmits the waveform with id wave_id. The waveform repeats
262-
until wave_tx_stop is called or another call to `wave_send_*`
262+
PiGPIO.wave_send_repeat(self::Pi, wave_id)
263+
264+
Transmits the waveform with id `wave_id`. The waveform repeats
265+
until `wave_tx_stop` is called or another call to `wave_send_*`
263266
is made.
264267
265-
NOTE: Any hardware PWM started by `hardware_PWM` will
266-
be cancelled.
268+
!!! note
269+
Any hardware PWM started by `hardware_PWM` will be cancelled.
267270
268271
* `wave_id`: >=0 (as returned by a prior call to `wave_create`).
269272
@@ -294,11 +297,13 @@ to sync with the previous waveform.
294297
`PiGPIO.WAVE_MODE_REPEAT_SYNC` same as `wave_send_repeat` but tries
295298
to sync with the previous waveform.
296299
297-
WARNING: bad things may happen if you delete the previous
298-
waveform before it has been synced to the new waveform.
300+
!!! warning
301+
302+
Bad things may happen if you delete the previous waveform before it has been synced to the new waveform.
303+
304+
!!! note
299305
300-
NOTE: Any hardware PWM started by `hardware_PWM` will
301-
be cancelled.
306+
Any hardware PWM started by `hardware_PWM` will be cancelled.
302307
303308
* `wave_id`: >=0 (as returned by a prior call to `wave_create`).
304309
@@ -368,8 +373,8 @@ end
368373
"""
369374
This function transmits a chain of waveforms.
370375
371-
NOTE: Any hardware PWM started by `hardware_PWM`
372-
will be cancelled.
376+
!!! note
377+
Any hardware PWM started by `hardware_PWM` will be cancelled.
373378
374379
The waves to be transmitted are specified by the contents
375380
of data which contains an ordered list of `wave_id`s

0 commit comments

Comments
 (0)