Skip to content

docs: fix unqualified class references in enums.py #1388

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.

Sign up for GitHub

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

Closed
Godzilaa wants to merge 1 commit into from
+8 −7
Closed

docs: fix unqualified class references in enums.py #1388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions news/1158.documentation
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fully qualify :class:`~icalendar.enums.FBTYPE` and :class:`~icalendar.enums.BUSYTYPE` cross-references in :class:`~icalendar.enums.FBTYPE` and :class:`~icalendar.enums.BUSYTYPE` docstrings so Sphinx can resolve the links correctly. @Godzilaa
14 changes: 7 additions & 7 deletions src/icalendar/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ class FBTYPE(StrEnum):
``BUSY_UNAVAILABLE``,
``BUSY_TENTATIVE``

See also :class:`BUSYTYPE`.
See also :class:`~icalendar.enums.BUSYTYPE`.

Purpose:
To specify the free or busy time type.
Expand Down Expand Up @@ -415,12 +415,12 @@ class BUSYTYPE(StrEnum):
``BUSY_TENTATIVE``

Description:
This property is used to specify the default busy time
type. The values correspond to those used by the :class:`FBTYPE`
parameter used on a "FREEBUSY" property, with the exception that
the "FREE" value is not used in this property. If not specified
on a component that allows this property, the default is "BUSY-
UNAVAILABLE".
This property is used to specify the default busy time type.
The values correspond to those used by the
:class:`~icalendar.enums.FBTYPE` parameter used on a "FREEBUSY"
property, with the exception that the "FREE" value is not used in
this property. If not specified on a component that allows this
property, the default is "BUSY-UNAVAILABLE".

Example:
The following is an example of this property:
Expand Down