[diaspy.git] / Changelog.markdown

## Changelog for `diaspy`, unofficla Diaspora\* API for Python

This changelog file follows few rules:

*   __rem__:    indicates removed features,
*   __new__:    indicates new features,
*   __upd__:    indicates updated features,
*   __dep__:    indicates deprecated features,

Deprecation means that in the next version feature will be removed.

Also, after every version there should be a brief note describing possible 
problems with migrating to it from older versions and usage of new features. 

Users can always read the manual and dcumentation to make themselves more knowledgeable and 
are encouraged to do so. They only need to remember that documentation is usually more 
up-to-date than manual and if conflicts appear they should follow the order:

*docstrings* -> *docs/* -> *manual/*


----

Version `0.3.2` (2013-08-):

* __upd__:  `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data,

----

Version `0.3.1` (2013-07-12):

* __upd__:  `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError`
* __upd__:  `models.Post()._fetch()` renamed to `_fetchdata()` (because of new `_fetchcomments()` method)
* __new__:  `models.Comment()` object: wrapper for comments, not to be created manually
* __new__:  `comments` parameter in `models.Post`: defines whether to fetch post's commets
* __new__:  `connection.Connection` has new parameter in `__init__()`: it's `schema`
* __new__:  `author()` method in `models.Post()`


The new parameter in `connection.Connection` is useful when operating with handles. 
As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an 
unhandled exception -- `requests.exceptions.MissingSchema`. 
Now, however, `Connection` will catch the exception, add missing schema and try once more. 
This parameter is provided to give programmers ability to manipulate it. 

Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing!

When it comes to posts, we are now able to fetch comments.

----

Version `0.3.0` (2013-07-07):

First edition of Changelog for `diaspy`. 
Developers should update their code as version `0.3.0` may not be fully 
backwards compatible depending on how the code is written. 
If you always pass named arguments and do not rely on their order you can, at least in 
theory, not worry about this update. 

Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of 
redesign and refactoring od `diaspy`'s code.

----
Commit	Line	Data
	1	## Changelog for `diaspy`, unofficla Diaspora\* API for Python
	2
	3	This 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
	10	Deprecation means that in the next version feature will be removed.
	11
	12	Also, after every version there should be a brief note describing possible
	13	problems with migrating to it from older versions and usage of new features.
	14
	15	Users can always read the manual and dcumentation to make themselves more knowledgeable and
	16	are encouraged to do so. They only need to remember that documentation is usually more
	17	up-to-date than manual and if conflicts appear they should follow the order:
	18
	19	docstrings -> docs/ -> manual/
	20
	21
	22	----
	23
	24	Version `0.3.2` (2013-08-):
	25
	26	* __upd__: `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data,
	27
	28	----
	29
	30	Version `0.3.1` (2013-07-12):
	31
	32	* __upd__: `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError`
	33	* __upd__: `models.Post()._fetch()` renamed to `_fetchdata()` (because of new `_fetchcomments()` method)
	34	* __new__: `models.Comment()` object: wrapper for comments, not to be created manually
	35	* __new__: `comments` parameter in `models.Post`: defines whether to fetch post's commets
	36	* __new__: `connection.Connection` has new parameter in `__init__()`: it's `schema`
	37	* __new__: `author()` method in `models.Post()`
	38
	39
	40	The new parameter in `connection.Connection` is useful when operating with handles.
	41	As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an
	42	unhandled exception -- `requests.exceptions.MissingSchema`.
	43	Now, however, `Connection` will catch the exception, add missing schema and try once more.
	44	This parameter is provided to give programmers ability to manipulate it.
	45
	46	Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing!
	47
	48	When it comes to posts, we are now able to fetch comments.
	49
	50	----
	51
	52	Version `0.3.0` (2013-07-07):
	53
	54	First edition of Changelog for `diaspy`.
	55	Developers should update their code as version `0.3.0` may not be fully
	56	backwards compatible depending on how the code is written.
	57	If you always pass named arguments and do not rely on their order you can, at least in
	58	theory, not worry about this update.
	59
	60	Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of
	61	redesign and refactoring od `diaspy`'s code.
	62
	63	----