collective / icalendar / 31411659406

98%

push

github

docs(alarm): consolidate parameters and docs of Alarm factory methods (#1603)

* docs(alarm): sort docstring params — required first, optional alphabetical

Reorder the Parameters sections of new_display, new_audio, and
new_email so required params come first, then optional params in
alphabetical order. Signatures are unchanged.

Per discussion in #1603 and #1618.

* docs(alarm): add Required. prefix to required params per review

* docs(news): add change log entry for alarm docstring consolidation

* docs(alarm): address docstring review follow-up

---------

Co-authored-by: Sashank <hello@sashank.wiki>

855 of 875 branches covered (97.71%)

Branch coverage included in aggregate %.

13998 of 14268 relevant lines covered (98.11%)

6.86 hits per line