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

Primitive Laws Docs #27

Open
chessai opened this issue Jul 20, 2018 · 2 comments
Open

Primitive Laws Docs #27

chessai opened this issue Jul 20, 2018 · 2 comments

Comments

@chessai
Copy link
Collaborator

chessai commented Jul 20, 2018

Currently there are nine (9) laws that we test for Prim. None of them are documented, users just get a vague Test that a 'Prim' instance obeys the several laws. I feel as though we should either

  1. wait for the primitive package to write the laws in their docs, but still explain what primLaws tests, or
  2. pre-emptively name the laws and write the docs in the same way that they are for all other classes
@andrewthad
Copy link
Owner

We should go ahead and document what we are testing. There's no need to wait on primitive.

@chessai
Copy link
Collaborator Author

chessai commented Jul 20, 2018

agreed, the 2nd option is mostly about naming

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

2 participants