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

Meta - documentation, comments, example code #254

Merged
merged 4 commits into from
Jan 15, 2023
Merged

Meta - documentation, comments, example code #254

merged 4 commits into from
Jan 15, 2023

Conversation

tobixen
Copy link
Member

@tobixen tobixen commented Jan 15, 2023

This is a collection of things that does not alter the caldav code itself:

  • Version number pushed from 0.x to 1.0. References API changes in version 2.0 and 3.0? #92,
  • Comments in the code, docstrings, and minor changes to a deprecation warning. Particularly TODO-comments and deprecation-comments.
  • Deprecation-policy nailed in the doc. Things that are marked as DEPRECATED by now may be removed in version 2.0. Version 1.x will (most likely) be supported at least for 3 years, probably more.
  • basic_usage_examples.py has been totally rewritten (and tested).
  • Minor change in the test framework - checking for the caldav_servers[i]["enable"] attribute has been moved from test_caldav.py to conf.py (was needed for being able to test the basic_usage_examples.py.

(note: some minor bugfixes and enhancements were needed to the library to successfully test the basic_usage_examples.py - this will be committed in a separate pull request)

@tobixen tobixen merged commit 100cb04 into master Jan 15, 2023
@tobixen tobixen deleted the docfixes branch January 15, 2023 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant