Opened 3 months ago

Last modified 3 months ago

#14229 new bug

Contraditions in users_guide/using-warnings.html

Reported by: MikolajKonarski Owned by:
Priority: low Milestone:
Component: Documentation Version: 8.2.1
Keywords: newcomers Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: Documentation bug Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:

Description

Lists are not updated in

https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/using-warnings.html

E.g., it says "The warnings that are not enabled by -Wall are...-Wredundant-constraints", but then it says "This option is on by default". Also "-Worphans" is on none of the list of enabled or not enabled flags and also there is no mention in its description if its enabled by default or not. I guess there may be more.

Also, it may be worth mentioning that obsolete warnings or warnings subsumed by others are not on any of the list, or whatever the actual rule is.

Change History (3)

comment:1 Changed 3 months ago by bgamari

Oh dear; yes, it was only a matter of time until this fell out of sync. I'm a bit on the fence regarding whether we should invest some effort into automating the documentation generation or just fix it this once and try to be more careful in the future.

comment:2 Changed 3 months ago by MikolajKonarski

That's actually an easy, nice, introductory ticket for would-be GHC-contributors, so why waste computing power, when humans can do it almost as well. :) We'd just need to post it once a major release on a page with intro tickets and perhaps advertise the page on some hacker forums.

comment:3 Changed 3 months ago by bgamari

Keywords: newcomers added

Indeed we have the newcomers tag for precisely this reason.

Note: See TracTickets for help on using tickets.