[dyno511]

Linked issue

• Contributes to [Beginner] Correct broken links to classes & functions in documentation #1158

Description

• Reverted changes to src/icalendar/cal/alarm.py as type annotation warnings will be addressed by sphinx-autodoc-typehints (see Fix broken cross-references in the documentation and enable nitpicky builds #2033 and Doc: drop Python 3.11 support, add 3.15 #2095).
• Fixed broken Sphinx cross-references to :class:~icalendar.cal.event.Event and :class:~icalendar.cal.todo.Todo in the docstring of vRecur in src/icalendar/prop/recur/recur.py.
• Added changelog entry in news/1158.documentation.5.rst.

Checklist

• I added a change log entry, following the instructions in all subsections under Change log requirements.
• I followed icalendar's Artificial intelligence policy and disclosed my Responsible AI use in my commit messages, if applicable.
• I added or updated tests, if applicable.
• I ran and ensured all tests pass locally by following Run tests.
• I added or edited documentation as necessary, both as docstrings to be rendered in the API documentation and narrative documentation, following the Style guide.

[github-actions]

Thanks for the pull request, @dyno511! A maintainer will review it shortly.

[github-actions]

Insufficient data

Not enough activity yet to make a reliable assessment.

View full analysis →

_{This is an automated analysis by AgentScan}

[stevepiercy]

I think that after #2033 is merged, then this PR will become unnecessary.

See also #2095. datetime stuff will resolve with an update to sphinx-autodoc-typehints.

[dyno511]

Thank you @stevepiercy for pointing that out!

I have completely reverted the changes in src/icalendar/cal/alarm.py so that datetime/timedelta typehints can be handled as intended in #2033 / #2095.

Instead, I have updated this PR to fix the broken docstring cross-references in src/icalendar/prop/recur/recur.py where :class:icalendar.cal.Event and `:class:`icalendar.cal.Todo were missing the submodule path in vRecur docstrings. I also updated the title, description, and news fragment accordingly.