-
-
Notifications
You must be signed in to change notification settings - Fork 405
Fix broken doc links in Calendar.new docstring #1732
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| Fixed two broken documentation cross-reference links in the | ||
| :meth:`~icalendar.cal.calendar.Calendar.new` docstring: the | ||
| :class:`~icalendar.cal.availability.Availability` class reference | ||
| was missing its full module path, and the ``DEFAULT_PRODID`` | ||
| reference pointed to an undocumented module-level constant and | ||
| was changed to plain code formatting instead. | ||
|
|
||
| I used AI to assist me with this change. | ||
|
|
||
| @Mohammed-Ahmed7 | ||
|
Comment on lines
+1
to
+10
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please put this on a single line, and update it to reflect the suggestions below. |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -169,7 +169,7 @@ def journals(self) -> list[Journal]: | |
|
|
||
| @property | ||
| def availabilities(self) -> list[Availability]: | ||
| """All :class:`Availability` components in the calendar. | ||
| """All :class:`Availability <icalendar.cal.availability.Availability>` components in the calendar. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See the "object only" syntax example at https://icalendar.readthedocs.io/en/latest/contribute/documentation/style-guide.html#cross-reference-python-objects.
Suggested change
"""All :class:`Availability <icalendar.cal.availability.Availability>` components in the calendar.
"""All :class:`~icalendar.cal.availability.Availability` components in the calendar.
|
||
|
|
||
| This is a shortcut to get all availabilities. | ||
| Modifications do not change the calendar. | ||
|
|
@@ -566,7 +566,7 @@ def new( | |
| prodid: The :attr:`prodid` of the component. If ``None`` and ``organization`` is provided, | ||
| generates a `prodid` in the format of "-//organization//name//language". | ||
| If ``None`` and ``organization`` is not provided, sets it to | ||
| :attr:`~icalendar.cal.calendar.DEFAULT_PRODID`. | ||
| ``DEFAULT_PRODID``. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please revert this change, and see my suggestion above. https://github.com/collective/icalendar/pull/1732/changes#r3879155959 |
||
| refresh_interval: The :attr:`refresh_interval` of the calendar. | ||
| refids: :attr:`~icalendar.cal.component.Component.refids` of the calendar. | ||
| related_to: :attr:`~icalendar.cal.component.Component.related_to` of the calendar. | ||
|
|
||