collective / icalendar / 25791561251

98%

push

github

docs(alarm): rewrite REPEAT and DURATION docstrings (refs #1244) (#1357)

* docs(alarm): rewrite REPEAT and DURATION docstrings (#1244)

Replace the RFC 5545 quotations on Alarm.REPEAT and Alarm.DURATION with
Pythonic descriptions: behavior summary, default and accepted types,
conformance reference via :rfc: directive, and a worked pycon example
that pairs the two properties (which the RFC says alarms with repeating
triggers MUST do).

Refs collective#1244 and follows the pattern from PR #1338 for
Calendar.categories.

* docs(alarm): apply review suggestions

Address @stevepiercy review feedback:
- Flatten the REPEAT "Conformance" block into the description and link the
  Alarm class via :class: instead of referencing the RFC "VALARM" name.
- Link DURATION via :attr: on the first mention in the property docstring.
- Apply the same Conformance-block flatten to DURATION.

* Move change log entry to unreleased version

---------

Co-authored-by: Steve Piercy <web@stevepiercy.com>

748 of 770 branches covered (97.14%)

Branch coverage included in aggregate %.

12340 of 12616 relevant lines covered (97.81%)

6.84 hits per line