Ticket #254 (closed defect: fixed)

Opened 5 years ago

Last modified 5 years ago

Misleading documentation on comments in .cabal

Reported by: guest Owned by:
Priority: low Milestone:
Component: miscellaneous Version: 1.2.3.0
Severity: minor Keywords:
Cc: Difficulty: very easy (<1 hour)
GHC Version: 6.8.2 Platform:

Description

in  http://www.haskell.org/cabal/release/latest/doc/users-guide/x30.html#pkg-descr we read, "In the package description file, lines beginning with "--" are treated as comments and ignored."

This isn't right, since it's actually -- after any amount of whitespace; you can indent as you please, and cabal will still treat it as a comment and not try to interpret your crazy English stuff. It's a bit misleading.

Change History

Changed 5 years ago by duncan

  • status changed from new to closed
  • resolution set to fixed

Fixed. 

Mon Mar  3 22:16:57 GMT 2008  Thomas Schilling <nominolo@gmail.com>
  * Clarify commenting rule for package description files.
Note: See TracTickets for help on using tickets.