collective / icalendar / 34174274773

98%

push

github

docs: stop composing single_utc_property docstrings from the property name (#1731)

* Stop composing UTC property docstrings from the property name

Each affected property now states its own type and UTC conversion once,
statically, at its call site. DTEND no longer reads "Start of the
component", and no timestamp property cites itself in its own See also.
Adds a regression test verified to fail without this change.

Contributes to #1650
AI: 千问办公 (QwenWork) agent drafted the docstrings and ran the test,
lint and docs checks; the author reviewed every changed line.

* Make stamp a distinct accessor instead of aliasing DTSTAMP

Per review: DTSTAMP = stamp = single_utc_property(...) shared one property
object between two public names, which made the shared docstring read as
self-referential under stamp. stamp is now a lowercase accessor following
the created/last_modified pattern: getter and setter, no deleter, since a
stamp should never be removed. The three timestamp properties share one
lowercase See also list, and the regression tests cover both.

18369 tests pass; ruff (pinned 0.15.2) check and format clean.

AI: qianwen office (QwenWork) agent implemented the API change selected in
review and updated the tests; the author reviewed every changed line.

* Address review: add stamp deleter, counterpart cross-references, merged news entry

- news/1650.documentation: replace the appended text with the reviewed
  single-paragraph wording
- stamp: docstring now states it is the lowercase property counterpart to,
  and accessor for, DTSTAMP; a deleter is added so deleting stamp still
  removes DTSTAMP, preserving the pre-existing functionality
- DTSTAMP / LAST_MODIFIED / CREATED See-also lists: list the uppercase
  counterparts plus the lowercase accessors, never the property itself
- tests: See-also test now asserts no self-reference while counterpart
  references remain allowed; the stamp test asserts the deleter removes
  DTSTAMP

AI: qianwen office (Qw... (continued)

1673 of 1812 branches covered (92.33%)

Branch coverage included in aggregate %.

40 of 40 new or added lines in 2 files covered. (100.0%)

14735 of 15005 relevant lines covered (98.2%)

6.87 hits per line