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

Document classes that the user cannot instantiate #37

Open
microbit-matt-hillsdon opened this issue May 4, 2022 · 1 comment
Open

Comments

@microbit-matt-hillsdon
Copy link
Contributor

Button, the pins classes, the mem class in machine and probably others are all classes we need in the API docs but aren't intended for the user to create. Let's add some clear consistent documentation explaining this.

@microbit-matt-hillsdon
Copy link
Contributor Author

uname_result is another example here of a class that only exists (in MicroPython at least) to document the structure of a return value. It's even less instantiable than the others.

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

1 participant