collective / icalendar / 31689683676

98%

push

github

docs: replace RFC copy-paste docstrings with Pythonic docstrings (#1385)

* docs: replace RFC copy-paste docstrings with Pythonic docstrings (#1244)

Rewrote RFC-verbatim docstrings for the following properties:

alarm.py:
- Alarm.ACKNOWLEDGED: replaced RFC 9074 Purpose/Description wall-of-text
  with a concise summary, Return, Example and See also sections.
- Alarm.TRIGGER: replaced RFC 5545 Purpose/Value-Type verbatim with a
  clear summary, type info, Example and See also.

component.py:
- Component.DTSTAMP / stamp: replaced 'RFC 5545: Conformance/Description'
  block with a Pythonic summary, context note, Example and See also.
- Component.LAST_MODIFIED: same pattern - Pythonic summary, Example, See also.
- Component.CREATED: same pattern - Pythonic summary, Example, See also.

calendar.py:
- Calendar.calendar_name: removed Property Parameters/Conformance/Description
  RFC headings; added See also.
- Calendar.description: same cleanup.
- Calendar.color: removed Property Parameters/Conformance/Description RFC
  headings; added CSS3 link reference and See also.
- Calendar.prodid: replaced Conformance/Description verbatim with Pythonic
  summary, Example and See also.
- Calendar.version: replaced Purpose RFC text with Pythonic summary + Example.
- Calendar.calscale: replaced Conformance/Description/Compatibility with
  Pythonic summary, RFC 7529 note, Example and See also.
- Calendar.method: replaced Description RFC block with Pythonic summary,
  iTIP/RFC 5546 reference, Example and See also.
- Calendar.refresh_interval: replaced Conformance/Description headings with
  Pythonic summary, updated Raises, added Example and See also.

* fix doctests: use ELLIPSIS for tzinfo and str() for vText values

* fix changelog: revert CHANGES.rst, add towncrier news fragment for #1385

* address reviewer suggestions: improve single_utc_property docstring, fix ACKNOWLEDGED and p_doc text

* Address remaining docstring review notes

* Correct the NAME property RFC se... (continued)

859 of 879 branches covered (97.72%)

Branch coverage included in aggregate %.

14096 of 14366 relevant lines covered (98.12%)

6.86 hits per line