penguinolog / urwid / 39755913303

90%

master: 92%

push

github

Complete the parameter, return, exception and warning fields in docstrings

Docstrings in urwid and examples now document what each callable takes, returns, raises and warns:

- :return: becomes :returns:, and "Returns ..." prose moves into a :returns: field before :raises:.
- Missing :param: entries are added where the other parameters were documented.
- Emitted warnings get one :warns X: field each, unless a deprecated notice covers them.
- ANSIText.from_lines documents :yields: instead of :returns:.
- Wrong statements are corrected: the _value_lookup_table result, remove_idle() -> remove_enter_idle(),
  the raise conditions of curses set_mouse_tracking, TreeNode.change_key, AttrSpec and calc wrap_keypress.

5301 of 6054 branches covered (87.56%)

Branch coverage included in aggregate %.

13359 of 14588 relevant lines covered (91.58%)

14.42 hits per line