diff options
| author | Marcin Kurczewski <rr-@sakuya.pl> | 2016-02-14 14:56:07 +0100 |
|---|---|---|
| committer | Marcin Kurczewski <rr-@sakuya.pl> | 2016-02-14 14:56:07 +0100 |
| commit | 84257ce849ca6ef36736ce4f35951a6787ac5a00 (patch) | |
| tree | 4696fbac8ddeab2b41a2cdc5109b1b4bcb803208 | |
| parent | 5c7bff3d381e855b483b7b65688ce2d4f53cdd1b (diff) | |
| download | urwid-84257ce849ca6ef36736ce4f35951a6787ac5a00.tar.gz | |
Correct Edit documentation
There were missing doc comments for a few basic properties, + the text about `edit_text` property being a read-only property was a lie.
| -rw-r--r-- | urwid/widget.py | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/urwid/widget.py b/urwid/widget.py index 661e7ed..42551af 100644 --- a/urwid/widget.py +++ b/urwid/widget.py @@ -1289,7 +1289,9 @@ class Edit(Text): self._caption, self._attrib = decompose_tagmarkup(caption) self._invalidate() - caption = property(lambda self:self._caption) + caption = property(lambda self:self._caption, doc=""" + Read-only property returning the caption for this widget. + """) def set_edit_pos(self, pos): """ @@ -1321,7 +1323,9 @@ class Edit(Text): self._edit_pos = pos self._invalidate() - edit_pos = property(lambda self:self._edit_pos, set_edit_pos) + edit_pos = property(lambda self:self._edit_pos, set_edit_pos, doc=""" + Property controlling the edit position for this widget. + """) def set_mask(self, mask): """ @@ -1373,7 +1377,7 @@ class Edit(Text): return self._edit_text edit_text = property(get_edit_text, set_edit_text, doc=""" - Read-only property returning the edit text for this widget. + Property controlling the edit text for this widget. """) def insert_text(self, text): |