Some bug fixes and small changes
[diaspy.git] / Changelog.markdown
... / ...
CommitLineData
1## Changelog for `diaspy`, unofficla Diaspora\* API for Python
2
3This changelog file follows few rules:
4
5* __rem__: indicates removed features,
6* __new__: indicates new features,
7* __upd__: indicates updated features,
8* __dep__: indicates deprecated features,
9
10Deprecation means that in the next version feature will be removed.
11
12Also, after every version there should be a brief note describing possible
13problems with migrating to it from older versions and usage of new features.
14
15Users can always read the manual and dcumentation to make themselves more knowledgeable and
16are encouraged to do so. They only need to remember that documentation is usually more
17up-to-date than manual and if conflicts appear they should follow the order:
18
19*docstrings* -> *docs/* -> *manual/*
20
21
22----
23
24Version `0.3.1` (2013-07-12):
25
26* __upd__: `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError`
27* __new__: `connection.Connection` has new parameter in `__init__()`: it's `schema`
28
29
30The new parameter in `connection.Connection` is useful when operating with handles.
31As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an
32unhandled exception -- `requests.exceptions.MissingSchema`.
33Now, however, `Connection` will catch the exception, add missing schema and try once more.
34This parameter is provided to give programmers ability to manipulate it.
35
36Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing!
37
38----
39
40Version `0.3.0` (2013-07-07):
41
42First edition of Changelog for `diaspy`.
43Developers should update their code as version `0.3.0` may not be fully
44backwards compatible depending on how the code is written.
45If you always pass named arguments and do not rely on their order you can, at least in
46theory, not worry about this update.
47
48Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of
49redesign and refactoring od `diaspy`'s code.
50
51----