ivanperez-keera / SpaceInvaders

A Haskell game written in Yampa
BSD 3-Clause "New" or "Revised" License
26 stars 16 forks source link

Haddock documentation is broken #5

Closed ivanperez-keera closed 7 years ago

ivanperez-keera commented 7 years ago

Haddock complains about the main module being present in multiple files.

This error message is quite misleading.

The problem is that files contain a $ symbol, usually in the very first line, used to make the control version system fill in some data inside the file (something that is no longer supported), which haddock thinks it's a haddock variable name.

For example: https://github.com/ivanperez-keera/SpaceInvaders/blob/develop/src/Animate.hs#L1

The only thing that's necessary is to go through all the files and remove that first line with the $Id.