Opened 6 months ago

Closed 6 months ago

Last modified 6 months ago

#8416 closed bug (fixed)

GHC.Generics needs more documentation

Reported by: tibbe Owned by:
Priority: normal Milestone: 7.8.1
Component: libraries/base Version: 7.6.3
Keywords: Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: Documentation bug Difficulty: Unknown
Test Case: Blocked By:
Blocking: Related Tickets:

Description

Recently I tried to used GHC.Generics "in anger" for the first time, to fix some code in hashable that wasn't originally written by me. After a while I just gave up (and the generics support in hashable is now somewhat broken). The documentation for GHC.Generics is too incomprehensible for mere mortals. In particular, I find the documentation for M1 and K1 not very helpful.

The documentation needs examples, more in-depth explanations of what each of the data types/constructors is used for, and finally an explanation of the up to 4 type parameters!

Change History (4)

comment:1 Changed 6 months ago by refold

I think that this is fixed in HEAD: [3b4ee00e3676c30814cd6ae68275cece0ba60b0d/base]

Last edited 6 months ago by hvr (previous) (diff)

comment:2 Changed 6 months ago by tibbe

  • Resolution set to fixed
  • Status changed from new to closed

comment:3 Changed 6 months ago by hvr

  • Milestone set to 7.8.1
  • Type of failure changed from None/Unknown to Documentation bug

comment:4 Changed 6 months ago by refold

  • Component changed from libraries (other) to libraries/base
Note: See TracTickets for help on using tickets.