richard-better / pushbullet.py

A python client for http://pushbullet.com
MIT License
575 stars 110 forks source link

Readme doesn't reflect actual structure of Pushbullet.get_pushes() return value #41

Closed obskyr closed 9 years ago

obskyr commented 9 years ago

The readme suggests that Pushbullet.get_pushes() returns a list of pushes. This is not true, however. It actually returns a two-length tuple, in which the first element is True and the second is the list of pushes.

Eg. the function currently returns:

>>>pb.get_pushes()
(True, [push0, push1, push2])

Instead of:

>>>pb.get_pushes()
[push0, push1, push2]

Simply updating the readme to reflect this (or changing the behavior of the function) would fix this. Some documentation of what the True means would be nice, too.

r-darwish commented 9 years ago

I think this can be closed now

obskyr commented 9 years ago

Ah, yes, indeed it can. Pull request #43 fixed it. Thanks!