Enriching the examples section on readthedocs
jacadzaca opened this issue · comments
The project can be improved with useful examples. The usage.rst
file contains examples already. However, more examples will improve the clarity. Please use one of the issues mentioned below to extract an example and make a pull request.
Issues/tests that contain possible examples:
- #85
- #210
- #267
- #301
- #317
- #341
- #342
- #421
- #425
- #390 - generating RFC compliant TIMEZONE components
- #130
- test_property_params and test_parse_and_access_property_params from test_property_params.py
- test_tools_UIDGenerator from test_unit_tools
- test_issue_116 from test_fixed_issues
- #510
See Also
- This issues arises from #439.
- icalendar examples on readthedocs.
- When #445 is merged, the examples will be tested with
doctest
so we can make sure that they are actually working.
I do not have an overview over different kinds of examples that are already there. We do not want to duplicate code if not necessary and also make sure that the existing examples get tested and are where a beginner expects to see them.
I would like to see examples in the future also of how to read icalendar files and how to use the command line.
Having used this library for a recent project of mine I feel the need for this initiative 😄
and I'm happy to help out
Is there a specific strategy or structure we want with the examples in the docs?
Or do we want to add any useful (but random) example?