search

anki / cozmo-python-sdk

Anki Cozmo Python SDK
Other
662 stars 430 forks source link

Update pets.py #173

Closed AndreiCostinescu closed 6 years ago

AndreiCostinescu commented 6 years ago

Clarity changes in the documentation of some functions.

AndreiCostinescu commented 6 years ago

Hi @MarkWesleyAtAnki there are also other places in other classes, where the documentation of the "Length of time in seconds" thing is used. In some cases, the documentation also features the "(0.2)".

If it disappears for more than
(old) PET_VISIBILITY_TIMEOUT (0.2) seconds and then is seen again, a    
(new) PET_VISIBILITY_TIMEOUT seconds and then is seen again, a
EvtPetDisappeared will be dispatched, followed by another EvtPetAppeared event.

Can I change this also in the other classes or is the (0.2) really relevant? :)

MarkWez commented 6 years ago

@AndreiCostinescu Yes, please change the other 0.2 entries too - they are misleading as the time was increased to 0.4 a few months back (without remembering to update these), and it's safer to just remove it from the comment to avoid it going out of sync again.

AndreiCostinescu commented 6 years ago

@MarkWesleyAtAnki Sure, thanks for the reply 👍