Skip to content

Commit

Permalink
Merge pull request #44 from RaspberryPiFoundation/dev
Browse files Browse the repository at this point in the history
doc updates
  • Loading branch information
Martin O'Hanlon authored Apr 8, 2022
2 parents d72ff6d + 064f914 commit 6d8d12c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
20 changes: 16 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,30 @@ A beginner-friendly library for using common electronics components with the Ras
Status
------

Beta. There will be bugs and issues. API changes are likely.
Beta. There will be bugs and issues. API changes are likely. More devices will be added over time.

Documentation
-------------

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

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

Notes
-----
Code
----

The code and project is at `github.com/RaspberryPiFoundation/picozero <https://github.com/RaspberryPiFoundation/picozero>`_.

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>`_).

The latest distribution is available at `pypi.org/project/picozero/ <https://pypi.org/project/picozero/>`_.

Thanks
------

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.
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.

.. |pypibadge| image:: https://badge.fury.io/py/picozero.svg
:target: https://badge.fury.io/py/picozero
Expand Down
3 changes: 2 additions & 1 deletion picozero/picozero.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,8 @@ def blink(self, on_time=1, off_time=None, n=None, wait=False):
The length of time in seconds the device will be on. Defaults to 1.
:param float off_time:
The length of time in seconds the device will be off. Defaults to 1.
The length of time in seconds the device will be off. If `None`,
it will be the same as ``on_time``. Defaults to `None`.
:param int n:
The number of times to repeat the blink operation. If None is
Expand Down

0 comments on commit 6d8d12c

Please sign in to comment.