-
Notifications
You must be signed in to change notification settings - Fork 68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add API docs #16
Add API docs #16
Conversation
This is a work in progress @kplindegaard, I'll let you know when it's ready for review. |
Looking forward to it. Thanks! |
@kplindegaard I see many methods with a comment before the docstring like this: def open(self, bus):
# type: (int) -> None
"""
Open a given i2c bus.
:param bus: i2c bus number (e.g. 0 or 1)
"""
self.fd = os.open("/dev/i2c-{}".format(bus), os.O_RDWR)
self.funcs = self._get_funcs() e.g. |
Go ahead. Could alternatively be deleted and we could add type hints in the docstring itself. |
I'll move them below the docstring and then you can later review them and move it into docstring. |
👍 |
@kplindegaard this PR should be ready to go. |
ps. i would squash merge this.. and you'll have to enable this repository on readthedocs. |
I hid some parts i don't think will be very relevant for the normal user and published the documentation on Read the docs |
fixes #5