V2 docs #692

microbit-mark · 2020-11-18T14:03:13Z

V2 MicroPython API reference docs.

microbit-carlos · 2020-11-25T17:21:16Z

Can we also change the copyright year from the config file? https://github.com/bbcmicrobit/micropython/blob/master/docs/conf.py#L56

docs/audio.rst

microbit-carlos · 2020-11-25T09:26:58Z

docs/audio.rst

@@ -14,7 +17,7 @@ which means that it can reproduce frequencies up to 3.9kHz.
 Functions
 =========

-.. py:function:: play(source, wait=True, pin=pin0, return_pin=None)
+.. py:function:: play(source, wait=True, pin=pin_speaker, return_pin=None)


The pin argument can now take a tuple of 2 pins in V2(pin_speaker, pin0).
Can we add multiple function signatures? Like

.. py:function:: play(source, wait=True, pin=pin_speaker, return_pin=None) .. py:function:: play(source, wait=True, pin=(pin_speaker, pin0))

Maybe there is something here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html

Des this work? https://microbit-micropython--692.org.readthedocs.build/en/692/audio.html#audio.play

Do you know if there is a way to add a note? Maybe like a (V1) or (V2) at the end?

I know exactly this might not be difficult (I just edited the HTML in the dev tools), but it's just to illustrate what I meant:

There might also be other ways to identify the different signatures? I'm very open for suggestions.

I haven't found a way to do this inline. Will keep looking

docs/audio.rst

docs/pin.rst

docs/speech.rst

examples/microphone.py

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

microbit-carlos

Great work Mark!
Just a couple of small comments and we are ready to merge!

docs/speech.rst

docs/music.rst

docs/microphone.rst

docs/audio.rst

docs/microbit_micropython_api.rst

docs/microphone.rst

docs/music.rst

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

microbit-carlos

Fantastic work Mark! Let's merge 🎉

* Add microphone API * include V2 on index * update music and V2 pins * update speech * update audio * update i2c * add description to built-in sounds * format sounds * format pins * format pins * spelling * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/i2c.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * changes based on initial feedback * update return pin * sound is in microbit module * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * more feedback updates * spacing * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * does this comment work? * Revert "does this comment work?" This reverts commit 4846113. * update audio * update audio * add Python Editor * add references to sound * update mic image * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * multiple fixes * use Param in docs * update SouneEvent * update microphone module * update param * update image list * update parameters * remove note * update param * add line break * add mic and make clases a-z * format parameters * Update docs/microbit_micropython_api.rst * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * more updates * tidy up * move SoundEvent * Revert "move SoundEvent" This reverts commit 8f52c97. * move soundEvent * update image list * remove param reference * more feedback updates * move audio to modules * Update docs/music.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/microphone.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/microbit_micropython_api.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/microphone.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/music.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * Update docs/audio.rst Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org> * more updates Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Add microphone API

e267646

microbit-carlos marked this pull request as ready for review November 18, 2020 17:52

microbit-carlos marked this pull request as draft November 18, 2020 17:59

microbit-carlos marked this pull request as ready for review November 18, 2020 17:59

microbit-carlos marked this pull request as draft November 18, 2020 18:03

microbit-carlos marked this pull request as ready for review November 18, 2020 18:03

microbit-carlos marked this pull request as draft November 18, 2020 18:06

microbit-carlos marked this pull request as ready for review November 18, 2020 18:06

microbit-carlos marked this pull request as draft November 18, 2020 18:08

microbit-carlos marked this pull request as ready for review November 18, 2020 18:13

microbit-mark added 5 commits November 25, 2020 09:43

include V2 on index

f3407cc

update music and V2 pins

656a2c2

update speech

97af5b3

update audio

2e5b2c8

update i2c

9205f32

microbit-mark force-pushed the v2-docs branch from 3d8ba6d to 9205f32 Compare November 25, 2020 09:43

microbit-mark added 5 commits November 25, 2020 10:28

add description to built-in sounds

3b49c8a

format sounds

198831f

format pins

f68e326

format pins

ad54991

spelling

0067550

microbit-carlos reviewed Nov 25, 2020

View reviewed changes

microbit-mark and others added 7 commits November 26, 2020 07:27

Update docs/audio.rst

11d1ab1

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/audio.rst

f5e4aed

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/i2c.rst

218ddd6

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/microbit_micropython_api.rst

10ab2ea

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/microbit_micropython_api.rst

529a165

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

changes based on initial feedback

78bd241

update return pin

63647a3

microbit-mark added 4 commits December 2, 2020 08:15

update image list

acd3c9d

remove param reference

b3c9957

more feedback updates

f5faefa

move audio to modules

bbe4d05

microbit-carlos reviewed Dec 2, 2020

View reviewed changes

microbit-mark and others added 7 commits December 3, 2020 10:58

Update docs/music.rst

1040971

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/microphone.rst

37acd15

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/microbit_micropython_api.rst

b20d460

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/microphone.rst

9e7e33c

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/music.rst

54e0eda

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

Update docs/audio.rst

bf9721d

Co-authored-by: Carlos Pereira Atencio <carlos@microbit.org>

more updates

8fe52d8

microbit-carlos approved these changes Dec 3, 2020

View reviewed changes

microbit-carlos merged commit 4c652da into bbcmicrobit:v2-docs Dec 3, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

V2 docs #692

V2 docs #692

microbit-mark commented Nov 18, 2020 •

edited

Loading

microbit-carlos commented Nov 25, 2020

microbit-carlos Nov 25, 2020

microbit-mark Nov 26, 2020

microbit-carlos Nov 26, 2020

microbit-mark Nov 26, 2020

microbit-carlos left a comment

microbit-carlos left a comment

V2 docs #692

V2 docs #692

Conversation

microbit-mark commented Nov 18, 2020 • edited Loading

microbit-carlos commented Nov 25, 2020

microbit-carlos Nov 25, 2020

Choose a reason for hiding this comment

microbit-mark Nov 26, 2020

Choose a reason for hiding this comment

microbit-carlos Nov 26, 2020

Choose a reason for hiding this comment

microbit-mark Nov 26, 2020

Choose a reason for hiding this comment

microbit-carlos left a comment

Choose a reason for hiding this comment

microbit-carlos left a comment

Choose a reason for hiding this comment

microbit-mark commented Nov 18, 2020 •

edited

Loading