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

Add haddocks for SharedTerm module #387

Closed
brianhuffman opened this issue Mar 13, 2019 · 0 comments · Fixed by #822
Closed

Add haddocks for SharedTerm module #387

brianhuffman opened this issue Mar 13, 2019 · 0 comments · Fixed by #822
Assignees
Labels
documentation Issues involving documentation
Milestone

Comments

@brianhuffman
Copy link
Contributor

Verifier.SAW.SharedTerm is our main user-facing api for building saw-core terms. We need to document it better.

For example, here's the documentation for scLambda:

scLambda :: SharedContext -> String -> Term -> Term -> IO Term

(I.e., there is none.) Users can't tell what the Term arguments are unless they look at the variable names in the source for hints.

We should have haddock documentation for every function exported from this module, at least.

@brianhuffman brianhuffman added the documentation Issues involving documentation label Apr 12, 2019
@atomb atomb added this to the 1.0 milestone Jun 4, 2019
@atomb atomb removed this from the 0.5 milestone Apr 3, 2020
@atomb atomb added this to the 0.6 milestone Apr 24, 2020
@ChrisEPhifer ChrisEPhifer self-assigned this Aug 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues involving documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants