Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation for AbstractConsumer #35

Open
philipaconrad opened this issue Dec 27, 2016 · 2 comments
Open

API documentation for AbstractConsumer #35

philipaconrad opened this issue Dec 27, 2016 · 2 comments

Comments

@philipaconrad
Copy link

In the online docs, API documentation exists for almost all of the fundamental stuff except the AbstractConsumer class, which is subclassed in the usage examples.

After looking in the code, it seems the class already has docstrings in place. Is there a reason for why its docs are missing? (like API instability, or somesuch?)

@veegee
Copy link
Owner

veegee commented Dec 27, 2016

Yes, the library is not at 1.0.0 and the undocumented stuff should be considered unstable. I haven't found a nice and clean way to create consumers short of just doing a simple function callback.

@philipaconrad
Copy link
Author

Thanks for the quick reply!

Your reply answers my question completely, but I'm not sure if closing the issue is the right thing to do, since the docs are not up, and won't be until the creation process for consumers stabilizes.

Maybe tag this issue enhancement, and leave it alone for now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants