summaryrefslogtreecommitdiff
path: root/wasp/draw565.py
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2020-05-14 20:44:05 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2020-05-14 20:44:05 (GMT)
commitf07fb6d22a7124f945a29c2895cec87a69e08b37 (patch)
treeb9acf1be1e3422ea8a8168ac92d0e219a16a767b /wasp/draw565.py
parent42fe7bf352c10b56ec4c53cd966bb819a81966c3 (diff)
wasp: draw565: docstrings for headings and __init__
Diffstat (limited to 'wasp/draw565.py')
-rw-r--r--wasp/draw565.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/wasp/draw565.py b/wasp/draw565.py
index f6fe272..a69e526 100644
--- a/wasp/draw565.py
+++ b/wasp/draw565.py
@@ -1,6 +1,10 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
# Copyright (C) 2020 Daniel Thompson
+"""RGB565 drawing library
+~~~~~~~~~~~~~~~~~~~~~~~~~
+"""
+
import array
import fonts.sans24
import micropython
@@ -76,6 +80,8 @@ class Draw565(object):
A full framebufer is not required although the library will
'borrow' a line buffer from the underlying display driver.
+
+ .. automethod:: __init__
"""
def __init__(self, display):
@@ -96,7 +102,7 @@ class Draw565(object):
self.set_font(fonts.sans24)
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
the background colour (typically black).