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.

Sign up for GitHub

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

Jump to bottom

Type RoundingMode has no formal documentation #836

Closed
brianhuffman opened this issue Jul 28, 2020 · 0 comments
Closed

Type RoundingMode has no formal documentation #836

brianhuffman opened this issue Jul 28, 2020 · 0 comments
Assignees
@brianhuffman
Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation

Comments

@brianhuffman
Copy link
Contributor

Type RoundingMode in the built-in Float.cry library has no docstring:

Cryptol> :m Float
Loading module Float
Float> :? RoundingMode

    type RoundingMode = [3]

We should add one. As it is intended to be an enumeration type, it might be nice for its docstring to list the names of the five declared "constructors" of type RoundingMode.

cryptol/lib/Float.cry

Line 30 in 5100132

type RoundingMode = [3]

@brianhuffman brianhuffman added the docs LaTeX, markdown, literate haskell, or in-REPL documentation label Jul 28, 2020
@brianhuffman brianhuffman self-assigned this Jul 28, 2020
brianhuffman pushed a commit that referenced this issue Jul 28, 2020
Add docstring for 'RoundingMode'. Fixes #836.
8cb98d3
brianhuffman pushed a commit that referenced this issue Jul 28, 2020
Merge pull request #842 from GaloisInc/issue836
1a2456a 
Add docstring for 'RoundingMode'. Fixes #836.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@brianhuffman brianhuffman

Labels
docs LaTeX, markdown, literate haskell, or in-REPL documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@brianhuffman