jfhbrook / pyee

A rough port of Node.js's EventEmitter to Python with a few tricks of its own
https://github.com/jfhbrook/public
MIT License
371 stars 39 forks source link

[question] recommended documentation method #48

Closed jlaine closed 6 years ago

jlaine commented 6 years ago

Hi!

First of all thanks for pyee and for making it asyncio-friendly with support for coroutines!

I am using pyee for aiortc, my Python/asyncio implementation of WebRTC . I was wondering whether you have a recommendation on how to document the events an object can emit?

jfhbrook commented 6 years ago

Not specifically - I've detailed this in my own stuff inside the __init__ doctring for my subclass before, but I wouldn't go so far as to call that a rec.

jlaine commented 6 years ago

Thanks for your answer, I might go the same way.