Skip to content
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

Create an CalendarObjectResource.icalendar_component property #232

Open
tobixen opened this issue Nov 21, 2022 · 2 comments
Open

Create an CalendarObjectResource.icalendar_component property #232

tobixen opened this issue Nov 21, 2022 · 2 comments

Comments

@tobixen
Copy link
Member

tobixen commented Nov 21, 2022

We have the event.icalendar_instance property, but then we also have a event.icalendar_object() method which returns the (sub)component of the icalendar instance. This is quite inconsistent and confusing.

RFC 5545 is consistently using the phrasing "component", and never "subcomponent". I think the proper name for the latter is event.icalendar_component - and for the sake of consistency, it should be a property, not a method. (however, event.icalendar_object needs to persist for quite some years yet for backward compatibility reasons).

@tobixen
Copy link
Member Author

tobixen commented Nov 21, 2022

Actually, icalendar_object was named _icalendar_object in v0.10, hence we don't need to worry about backward compatibility. The icalendar_component-property will be released in v0.11, but documentation needs to be fixed before the issue can be closed. Should also take a look through the example code and see if it can be used there.

@tobixen tobixen added doc and removed enhancement labels Nov 23, 2022
@tobixen
Copy link
Member Author

tobixen commented Nov 30, 2022

I'll make a separate issue for the doc with a better description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant