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

Define the "board" behavior explicitly, and document #7

Open
jisaacstone opened this issue Oct 21, 2020 · 0 comments
Open

Define the "board" behavior explicitly, and document #7

jisaacstone opened this issue Oct 21, 2020 · 0 comments
Labels
code-cleanup documentation Improvements or additions to documentation

Comments

@jisaacstone
Copy link
Owner

jisaacstone commented Oct 21, 2020

structs that are values in the board key of a Table struct are expected to be from modules that have certain methods defined. This is not documented and cannot be type checked by dialyzer either.

Documentation is required at a minimum, explicit behaviors or types would be ideal

@jisaacstone jisaacstone added documentation Improvements or additions to documentation code-cleanup labels Oct 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-cleanup documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant