collective / icalendar / 41825968981

98%

push

github

docs: convert Component._encode docstring to Google style (#1617)

* docs: convert Component._encode docstring to Google style

Contributes to #1072. Replaces the Sphinx-style :param:/:type:/:returns:
markup on Component._encode with the project's Google-style
Parameters/Returns sections, per the documentation style guide. No
behavior change.

AI disclosure: I used Claude (Anthropic, Sonnet 5) to identify an
unclaimed target for icalendar issue #1072, draft the converted
docstring text following the project's style guide, and verify it
locally (ruff, pytest, doctest). I reviewed and validated the change.

* Apply batched suggestions from code review

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

* Fixed parameters for ``icalendar.cal.component.Component._encode``

---------

Co-authored-by: harsh7733ai <23107090@apsit.edu.in>
Co-authored-by: angatha <59320234+angatha@users.noreply.github.com>
Co-authored-by: Steve Piercy <web@stevepiercy.com>

2084 of 2228 branches covered (93.54%)

Branch coverage included in aggregate %.

18734 of 19005 relevant lines covered (98.57%)

6.9 hits per line