wasp: draw565: docstrings for headings and __init__
This commit is contained in:
parent
42fe7bf352
commit
f07fb6d22a
2 changed files with 7 additions and 2 deletions
|
@ -62,7 +62,6 @@ Libraries
|
||||||
|
|
||||||
.. automodule:: draw565
|
.. automodule:: draw565
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
|
||||||
|
|
||||||
.. automodule:: icons
|
.. automodule:: icons
|
||||||
:members:
|
:members:
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
# SPDX-License-Identifier: LGPL-3.0-or-later
|
# SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
# Copyright (C) 2020 Daniel Thompson
|
# Copyright (C) 2020 Daniel Thompson
|
||||||
|
|
||||||
|
"""RGB565 drawing library
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
"""
|
||||||
|
|
||||||
import array
|
import array
|
||||||
import fonts.sans24
|
import fonts.sans24
|
||||||
import micropython
|
import micropython
|
||||||
|
@ -76,6 +80,8 @@ class Draw565(object):
|
||||||
|
|
||||||
A full framebufer is not required although the library will
|
A full framebufer is not required although the library will
|
||||||
'borrow' a line buffer from the underlying display driver.
|
'borrow' a line buffer from the underlying display driver.
|
||||||
|
|
||||||
|
.. automethod:: __init__
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, display):
|
def __init__(self, display):
|
||||||
|
@ -96,7 +102,7 @@ class Draw565(object):
|
||||||
self.set_font(fonts.sans24)
|
self.set_font(fonts.sans24)
|
||||||
|
|
||||||
def fill(self, bg=None, x=0, y=0, w=None, h=None):
|
def fill(self, bg=None, x=0, y=0, w=None, h=None):
|
||||||
"""Draw a solid color rectangle.
|
"""Draw a solid colour rectangle.
|
||||||
|
|
||||||
If no arguments a provided the whole display will be filled with
|
If no arguments a provided the whole display will be filled with
|
||||||
the background colour (typically black).
|
the background colour (typically black).
|
||||||
|
|
Loading…
Reference in a new issue