Add haddock comments to Candidate

Summary:
When documenting `Types.hs` last week I got confused about what the Bool
represented here, following up on a suggestion to add a doc comment

Reviewed By: chessai

Differential Revision: D28412103

fbshipit-source-id: 01af1f0831fc3e49d4b7f5bb9a4e89c5897b3d25
This commit is contained in:
Steven Troxler 2021-05-13 11:12:09 -07:00 committed by Facebook GitHub Bot
parent d6587dafbb
commit fcdd8047a3

View File

@ -252,7 +252,12 @@ instance Ord ResolvedToken where
z -> z
z -> z
data Candidate = Candidate ResolvedToken Double Bool
-- |A Candidate represents a potential match going into the ranker
data Candidate = Candidate
ResolvedToken -- ^ The actual resolved token we are considering
Double -- ^ naive Bayes log-likelihood - sum of LL of all rules used
Bool -- ^ Does the ResolvedToken's dimension match the caller's request?
deriving (Eq, Show)
instance Ord Candidate where