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

Inaccurate docs for MinimumMatch #211

Open
andrewthad opened this issue Oct 10, 2017 · 0 comments
Open

Inaccurate docs for MinimumMatch #211

andrewthad opened this issue Oct 10, 2017 · 0 comments

Comments

@andrewthad
Copy link
Collaborator

This is the definition of MinimumMatch, along with it's haddock comment:

{-| 'MinimumMatch' controls how many should clauses in the bool query should
     match. Can be an absolute value (2) or a percentage (30%) or a
     combination of both.
-}
newtype MinimumMatch =
  MinimumMatch Int deriving (Eq, Read, Show, Generic, ToJSON, FromJSON, Typeable)

It does not appear that we are actually able to distinguish between absolute values and percentages. Two possible solutions:

  1. Clarify in the comments that only absolute values are accepted.
  2. Turn MinimumMatch into a sum that gives users the choice. (breaking change)

I'm happy to do either of these.

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