Skip to content

Commit 6d8d12c

Browse files
author
Martin O'Hanlon
authored
Merge pull request #44 from RaspberryPiFoundation/dev
doc updates
2 parents d72ff6d + 064f914 commit 6d8d12c

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

README.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,30 @@ A beginner-friendly library for using common electronics components with the Ras
2121
Status
2222
------
2323

24-
Beta. There will be bugs and issues. API changes are likely.
24+
Beta. There will be bugs and issues. API changes are likely. More devices will be added over time.
25+
26+
Documentation
27+
-------------
2528

2629
Documentation is available at `picozero.readthedocs.io <https://picozero.readthedocs.io>`_ :
2730

2831
- `Installation and getting started guide <https://picozero.readthedocs.io/en/latest/gettingstarted.html>`_
2932
- `Recipes and how-to's <https://picozero.readthedocs.io/en/latest/recipes.html>`_
3033
- `API <https://picozero.readthedocs.io/en/latest/api.html>`_
3134

32-
Notes
33-
-----
35+
Code
36+
----
37+
38+
The code and project is at `github.com/RaspberryPiFoundation/picozero <https://github.com/RaspberryPiFoundation/picozero>`_.
39+
40+
Issues can be raised at `github.com/RaspberryPiFoundation/picozero/issues <https://github.com/RaspberryPiFoundation/picozero/issues>`_ (see `contributing <https://picozero.readthedocs.io/en/latest/contributing.html>`_).
41+
42+
The latest distribution is available at `pypi.org/project/picozero/ <https://pypi.org/project/picozero/>`_.
43+
44+
Thanks
45+
------
3446

35-
picozero is inspired by `gpiozero <https://gpiozero.readthedocs.io/en/stable/>`_ (and reuses some of its underlying structure), but is by design lighter weight and aligned with the Raspberry Pi Pico. Thank you to everyone who has contributed to the gpiozero project.
47+
picozero is inspired by `gpiozero <https://gpiozero.readthedocs.io/en/stable/>`_ (and reuses some of its underlying structure), but is, by design, lighter weight and aligned with the Raspberry Pi Pico. Thank you to everyone who has contributed to the gpiozero project.
3648

3749
.. |pypibadge| image:: https://badge.fury.io/py/picozero.svg
3850
:target: https://badge.fury.io/py/picozero

picozero/picozero.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,8 @@ def blink(self, on_time=1, off_time=None, n=None, wait=False):
205205
The length of time in seconds the device will be on. Defaults to 1.
206206
207207
:param float off_time:
208-
The length of time in seconds the device will be off. Defaults to 1.
208+
The length of time in seconds the device will be off. If `None`,
209+
it will be the same as ``on_time``. Defaults to `None`.
209210
210211
:param int n:
211212
The number of times to repeat the blink operation. If None is

0 commit comments

Comments
 (0)