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 the significance of Nothing :: Maybe CharacterSet #2527

Open
fpringle opened this issue Jul 13, 2023 · 0 comments
Open

Document the significance of Nothing :: Maybe CharacterSet #2527

fpringle opened this issue Jul 13, 2023 · 0 comments

Comments

@fpringle
Copy link

The Lam, Pi, Combine, CombineTypes, Prefer and Equivalent constructors of Expr all have a Maybe CharacterSet field, without any documentation describing what a Nothing would signify in this context. Based on the source code I believe Nothing means "infer the CharacterSet based on the input". If this it the case, some documentation should be added to the constructors to explain this. Alternatively, a sum-type would be more expressive e.g.

data CharacterSetSource
  = Infer
  | Specify CharacterSet
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