diff --git a/CHANGES.rst b/CHANGES.rst index 827fa0a1..ac56b1d0 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -44,7 +44,8 @@ New features: Bug fixes: -- ... +- Rename RFC 2445 to RFC 5545, see `Issue 278 + `_ 5.0.13 (2024-06-20) ------------------- diff --git a/docs/about.rst b/docs/about.rst index 7a1b082e..ec249de0 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -7,8 +7,7 @@ iCalendar package for Python. The inspiration has come from the email package in the standard lib, which he thinks is pretty simple, yet efficient and powerful. -The icalendar package is an RFC 5545-compatible parser/generator for iCalendar files. +The ``icalendar`` package is an `RFC 5545 ` +compatible parser/generator for iCalendar files. .. _`Max M`: http://www.mxm.dk -.. _`RFC 2445`: https://tools.ietf.org/html/rfc2445 -.. _`RFC 5545`: https://tools.ietf.org/html/rfc5545 diff --git a/docs/usage.rst b/docs/usage.rst index 4194577c..08621c4a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -2,7 +2,7 @@ iCalendar package ================= This package is used for parsing and generating iCalendar files following the -standard in RFC 2445. +standard in RFC 5545. It should be fully compliant, but it is possible to generate and parse invalid files if you really want to. @@ -129,7 +129,7 @@ added. Here is an example:: END:VCALENDAR Note: this version doesn't check for compliance, so you should look in -the RFC 2445 spec for legal properties for each component, or look in +the RFC 5545 spec for legal properties for each component, or look in the icalendar/calendar.py file, where it is at least defined for each component. diff --git a/src/icalendar/cal.py b/src/icalendar/cal.py index 02a1fa6d..8708328d 100644 --- a/src/icalendar/cal.py +++ b/src/icalendar/cal.py @@ -1,5 +1,5 @@ """Calendar is a dictionary like Python object that can render itself as VCAL -files according to rfc2445. +files according to RFC 5545. These are the defined components. """ @@ -37,7 +37,7 @@ def get_example(component_directory: str, example_name: str) -> bytes: # The component factory class ComponentFactory(CaselessDict): - """All components defined in rfc 2445 are registered in this factory class. + """All components defined in RFC 5545 are registered in this factory class. To get a component you can use it like this. """ @@ -69,7 +69,7 @@ def __init__(self, *args, **kwargs): class Component(CaselessDict): """Component is the base object for calendar, Event and the other - components defined in RFC 2445. Normally you will not use this class + components defined in RFC 5545. Normally you will not use this class directly, but rather one of the subclasses. """ diff --git a/src/icalendar/parser.py b/src/icalendar/parser.py index ddfcf2d3..10d95ad6 100644 --- a/src/icalendar/parser.py +++ b/src/icalendar/parser.py @@ -1,4 +1,4 @@ -"""This module parses and generates contentlines as defined in RFC 2445 +"""This module parses and generates contentlines as defined in RFC 5545 (iCalendar), but will probably work for other MIME types with similar syntax. Eg. RFC 2426 (vCard) @@ -174,7 +174,7 @@ class Parameters(CaselessDict): """ def params(self): - """In rfc2445 keys are called parameters, so this is to be consitent + """In RFC 5545 keys are called parameters, so this is to be consitent with the naming conventions. """ return self.keys() diff --git a/src/icalendar/prop.py b/src/icalendar/prop.py index 61473219..7561dab3 100644 --- a/src/icalendar/prop.py +++ b/src/icalendar/prop.py @@ -20,7 +20,7 @@ iCalendar properties have values. The values are strongly typed. This module defines these types, calling val.to_ical() on them will render them as defined -in rfc2445. +in rfc5545. If you pass any of these classes a Python primitive, you will have an object that can render itself as iCalendar formatted date. @@ -869,7 +869,7 @@ def from_ical(cls, ical): class TypesFactory(CaselessDict): - """All Value types defined in rfc 2445 are registered in this factory + """All Value types defined in RFC 5545 are registered in this factory class. The value and parameter names don't overlap. So one factory is enough for diff --git a/src/icalendar/tests/prop/test_unit.py b/src/icalendar/tests/prop/test_unit.py index 9228e6fd..5c302077 100644 --- a/src/icalendar/tests/prop/test_unit.py +++ b/src/icalendar/tests/prop/test_unit.py @@ -223,7 +223,7 @@ def test_prop_vText(self): b'Text with escaped\\n chars') # If you pass a unicode object, it will be utf-8 encoded. As this is - # the (only) standard that RFC 2445 support. + # the (only) standard that RFC 5545 support. t = vText('international chars \xe4\xf6\xfc') self.assertEqual(t.to_ical(), b'international chars \xc3\xa4\xc3\xb6\xc3\xbc') diff --git a/src/icalendar/tests/test_parsing.py b/src/icalendar/tests/test_parsing.py index 940f2457..6aa0fa78 100644 --- a/src/icalendar/tests/test_parsing.py +++ b/src/icalendar/tests/test_parsing.py @@ -134,7 +134,7 @@ def test_no_tzid_when_utc(utc, date, expected_output): https://github.com/collective/icalendar/issues/58 https://github.com/collective/icalendar/issues/335 ''' - # According to RFC 2445: "The TZID property parameter MUST NOT be + # According to RFC 5545: "The TZID property parameter MUST NOT be # applied to DATE-TIME or TIME properties whose time values are # specified in UTC. date = date.replace(tzinfo=utc) diff --git a/src/icalendar/tests/test_unit_cal.py b/src/icalendar/tests/test_unit_cal.py index 007d38b0..933052c7 100644 --- a/src/icalendar/tests/test_unit_cal.py +++ b/src/icalendar/tests/test_unit_cal.py @@ -80,7 +80,7 @@ def test_default_list_example(c): def test_render_component(calendar_component): - """The component can render itself in the RFC 2445 format.""" + """The component can render itself in the RFC 5545 format.""" calendar_component.add('attendee', 'Max M') assert calendar_component.to_ical() == b'BEGIN:VCALENDAR\r\nATTENDEE:Max M\r\nEND:VCALENDAR\r\n'