Skip to content

CV class: docs? Non-public? #11

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

Closed
rpavlik opened this issue Mar 16, 2021 · 2 comments
Closed

CV class: docs? Non-public? #11

rpavlik opened this issue Mar 16, 2021 · 2 comments

Comments

@rpavlik
Copy link
Contributor

rpavlik commented Mar 16, 2021

This shows up in the docs, but the actual "constants" being defined don't. Am I correct in thinking this is basically a "fancy Enum" class? Any way to get the constants defined within to show up in docs https://circuitpython.readthedocs.io/projects/emc2101/en/latest/api.html#adafruit_emc2101.CV short of manually documenting them? Can we just remove this class from the public interface entirely? I don't imagine library users are meant to use it directly.

@tannewt
Copy link
Member

tannewt commented Mar 18, 2021

Ya, I think you can hide it with "_".

@jposada202020
Copy link
Contributor

Solved by #15 . Closing. Thanks

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

No branches or pull requests

3 participants