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

Clarify makeFieldLabels prefix requirements #472

Open
adamgundry opened this issue Nov 24, 2022 · 0 comments
Open

Clarify makeFieldLabels prefix requirements #472

adamgundry opened this issue Nov 24, 2022 · 0 comments

Comments

@adamgundry
Copy link
Member

Talking to @edsko I think the current distinction between makeFieldLabels and makeFieldLabelsNoPrefix is a bit non-obvious. In particular, if a user uses makeFieldLabels on a datatype that has no prefixes, it will silently succeed but generate no LabelOptic instances.

I think we should:

  • Document in the Haddocks that the prefixes are required, and explain what to do if different prefix rules are preferred.
  • Have makeFieldLabels emit a warning if none of the fields have the expected prefix.
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