collective / icalendar / 30537487102

98%

push

github

Fix FreeBusy.new() docstring referencing alarm instead of free/busy (#1503)

* Fix FreeBusy.new() docstring referencing alarm instead of free/busy

The FreeBusy.new() docstring summary was copied from the Alarm class and
incorrectly described creating an alarm. Corrected it to reference the
free/busy component. Verified the property structure against RFC 5545
section 3.6.4; the implementation already matches, only the docstring
text was inaccurate.

AI assistance: Claude Opus 4.5 (Anthropic), used via the web chat
interface to help locate the issue, verify the property structure against
RFC 5545, and draft the docstring correction. I reviewed and validated
the change and take responsibility for it.

* Fix FreeBusy.new() docstring: reference free/busy component instead of alarm

Aligns docstring structure with Event.new() convention (summary line +
RFC reference line) while linking directly to RFC 5545 section 3.6.4 for
precision, per review feedback.

* Use "free/busy" instead of "component" in FreeBusy.new() docstring

Matches how Event.new() refers to "the event" in its parameter docs.
Also fixed the Raises: line, it was missing the :exc: role.

* Update news/1473.documentation

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

* Update src/icalendar/cal/free_busy.py

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

* Name the required properties in FreeBusy.new() docstring

Replaced the RFC-citation sentence with an explicit list of required
properties (UID and DTSTAMP), per stevepiercy's suggestion.

* Connect required properties to their new() parameter names

Per stevepiercy's suggestion, note that UID and DTSTAMP may be set
via the uid and stamp parameters.

---------

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

843 of 865 branches covered (97.46%)

Branch coverage included in aggregate %.

13775 of 14051 relevant lines covered (98.04%)

6.86 hits per line