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

Enhance Documentation #626

Open
19 tasks
niccokunzmann opened this issue Jun 7, 2024 · 0 comments
Open
19 tasks

Enhance Documentation #626

niccokunzmann opened this issue Jun 7, 2024 · 0 comments
Labels
doc good first issue hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/

Comments

@niccokunzmann
Copy link
Member

niccokunzmann commented Jun 7, 2024

When I skip over usage.html, I think, this can be structured in a better way, more descriptive in places and also have more content.

Here is a list of what I think can be improved. For each item, please open a separate pull request.

  • change RFC 2445 to 5545 where you can find it
  • File structure and overview can be merged.
  • SUMMARY: might not be legal in the RFC, check it and make it X-CAL-DESCRIPTION or something used eitherway
  • How to open a file with a Calendar object
  • How to save a file
  • How to add an event
  • How to add an event in the local time zone, e.g. using tzlocal
  • How to create a recurring event
  • How to modify an event in a series
  • How to remove an event that happens at a specific time
  • How to remove all events in a series
  • How to add an alarm to an event
  • How to make sure that timezone components are automatically added.
  • add() is mentioned but not called
  • change pytz occurrences after Transition from pytz to zoneinfo #609 to zoneinfo
  • Example heading should be more descriptive of what it actually does
  • Overview over components
  • Overview over properties
  • File Structure could be moved more to the bottom because people might not be interested in it at the start but what to USE the module which is actually the name of the file - maybe it should be moved somewhere else.

See also:

@niccokunzmann niccokunzmann added the hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/ label Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc good first issue hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/
Projects
None yet
Development

No branches or pull requests

1 participant