emilypi / smash

Smash products, Wedge products, and other Pointed stuff
34 stars 11 forks source link

Haddock syntax woes. #3

Closed phadej closed 3 years ago

phadej commented 4 years ago

You have

-- 'Smash a b' or 'Maybe (Either a b)'

which should be written as

-- @'Smash' a b@ or @'Maybe' ('Either' a b)@

i.e. at marks code, and quotes delimit an identifier to be linked. If you don't want links, you can use just

-- @Smash a b@ or @Maybe (Either a b)@

The mistake seems to be systematic, so I won't fix it myself.

phadej commented 4 years ago

Kind of relatedly, haddoc linking of operators is tricky. You have write something like:

-- @(',')@

to link one. E.g. lens has

src/Control/Lens/Lens.hs:-- @('<<%=') :: 'MonadState' s m => 'LensLike' ((,)a) s s a b -> (a -> b) -> m a@
emilypi commented 4 years ago

"Woes" is the correct word. I can never get these damned docs right

emilypi commented 3 years ago

Closed in #18