Conversation
... and :rfc:-references in the documentation. Fixes #635
Seems like a was missing here - that explains why the document didn't get linked up properly on the readthedocs site
stevepiercy
left a comment
stevepiercy
left a comment
There was a problem hiding this comment.
Only a quick review on the :rfc: role usage.
caldav/calendarobjectresource.py
Outdated
| """ | ||
| Returns True if this object is a request, see | ||
| https://www.rfc-editor.org/rfc/rfc2446.html#section-3.2.2 | ||
| https://datatracker.ietf.org/doc/html/rfc2446#section-3.2.2 |
There was a problem hiding this comment.
Let's make these pretty in the API docs. See https://caldav.readthedocs.io/latest/caldav/calendarobjectresource.html#caldav.calendarobjectresource.CalendarObjectResource.is_invite_request for example.
| https://datatracker.ietf.org/doc/html/rfc2446#section-3.2.2 | |
| :rfc:`2446#section-3.2.2`. |
caldav/calendarobjectresource.py
Outdated
| """ | ||
| Returns True if the object is a reply, see | ||
| https://www.rfc-editor.org/rfc/rfc2446.html#section-3.2.3 | ||
| https://datatracker.ietf.org/doc/html/rfc2446#section-3.2.3 |
There was a problem hiding this comment.
| https://datatracker.ietf.org/doc/html/rfc2446#section-3.2.3 | |
| :rfc:`2446#section-3.2.3`. |
caldav/collection.py
Outdated
| The `Calendar` object is used to represent a calendar collection. | ||
| Refer to the RFC for details: | ||
| https://tools.ietf.org/html/rfc4791#section-5.3.1 | ||
| https://datatracker.ietf.org/doc/html/rfc4791#section-5.3.1 |
There was a problem hiding this comment.
https://caldav.readthedocs.io/latest/caldav/collection.html#caldav.collection.Calendar
| https://datatracker.ietf.org/doc/html/rfc4791#section-5.3.1 | |
| :rfc:`4791#section-5.3.1`. |
There was a problem hiding this comment.
I don't know whether you include this file in the docs. It appears to be a TODO list. If so, then this is good, otherwise let me know and we should use the reStructuredText syntax instead.
docs/source/about.rst
Outdated
|
|
||
| RFC 4791, 2518, 5545, 6638 et al | ||
| -------------------------------- | ||
| :rfc:`4791`, 2518, 5545, 6638 et al |
There was a problem hiding this comment.
I'd just make this heading generic.
Also headings should not have links in them.
| :rfc:`4791`, 2518, 5545, 6638 et al | |
| RFC compliance |
docs/source/about.rst
Outdated
| scope of this library is basically to cover RFC 4791/4918, the actual | ||
| :rfc:`4791` (CalDAV) outlines the standard way of communicating with a | ||
| calendar server. :rfc:`4791` is an extension of :rfc:`4918` (WebDAV). The | ||
| scope of this library is basically to cover :rfc:`4791`/:rfc:`4918`, the actual |
There was a problem hiding this comment.
I think that the rst link syntax won't work without spaces. Haven't checked. In any case, this is grammatically correct.
| scope of this library is basically to cover :rfc:`4791`/:rfc:`4918`, the actual | |
| scope of this library is basically to cover :rfc:`4791` and :rfc:`4918`, the actual |
docs/source/about.rst
Outdated
| RFC 6638/RFC 6047 is extending the CalDAV and iCalendar protocols for | ||
| scheduling purposes, work is in progress to support RFC 6638. Support | ||
| for RFC 6047 is considered mostly outside the scope of this library, | ||
| :rfc:`6638`/:rfc:`6047` is extending the CalDAV and iCalendar protocols for |
There was a problem hiding this comment.
| :rfc:`6638`/:rfc:`6047` is extending the CalDAV and iCalendar protocols for | |
| :rfc:`6638` and :rfc:`6047` extend the CalDAV and iCalendar protocols for |
There was a problem hiding this comment.
Use the :rfc: role for RFCs throughout this new document.
|
Right, I forgot that the docstrings are also rst text |
2 participants
This solves issue #635
I'm also piggy-backing some other documentation changes in this pull request