Create an example for a component (Python)

[niccokunzmann]

To enhance the documentation, it is nice to have examples!

• Todo
  • add src/icalendar/tests/todos/example.ics (or a different name)
  • add example() method with default
  • show how to use the example in the class docstring
  • test in src/icalendar/tests/test_examples.py
• Journal
  • add src/icalendar/tests/journals/example.ics (or a different name)
  • add example() method with default
  • show how to use the example in the class docstring
  • test in src/icalendar/tests/test_examples.py
• FreeBusy
  • add src/icalendar/tests/freebusy/example.ics (or a different name)
  • add example() method with default
  • show how to use the example in the class docstring
  • test in src/icalendar/tests/test_examples.py
• Alarm
  • add src/icalendar/tests/alarms/example.ics (or a different name)
  • add example() method with default
  • show how to use the example in the class docstring
  • test in src/icalendar/tests/test_examples.py
• Event
  • add src/icalendar/tests/events/example.ics (or a different name)
  • add example() method with default
  • show how to use the example in the class docstring
  • test in src/icalendar/tests/test_examples.py
• Calendar
  • add src/icalendar/tests/calendars/example.ics (or a different name)
  • add example() method with default
  • show how to use the example in the class docstring
  • test in src/icalendar/tests/test_examples.py
• Timezone
  • add src/icalendar/tests/timezones/example.ics (or a different name)
  • add example() method with default
  • show how to use the example in the class docstring
  • test in src/icalendar/tests/test_examples.py

This is an issue for beginners.
Please open a Pull Request to let us know you are working on it or ask below if you need any help!
A pull request should address at least one item in the list above. No need to do all at once.

Please also have a look at:

• https://icalendar.readthedocs.io/en/latest/
• https://github.com/collective/icalendar/tree/main/src/icalendar/tests
• https://www.rfc-editor.org/info/rfc5545 has the specification and examples

[prakrit55]

@niccokunzmann, I want to give it a try

[niccokunzmann]

@prakrit55 thanks, yes you are very welcome to! Let me know if you need anything. There is no need to solve all of this at once.

[prakrit55]

@niccokunzmann, do we need to create the class Docstring

[niccokunzmann]

For a pull request for this issue, it is enough to solve one of these many points. Some of them refer to the class doc string. You can focus on others first if you like, e.g. create an example.ics. Also if you create a Pull Request as soon as possible, we can discuss it there, too.
To solve the whole issue in the end, the class doc string is required.

Could I answer your question?