Ticket #43 (new enhancement)

Opened 6 years ago

Last modified 8 months ago

Comments on GADT constructors

Reported by: jeanphilippe.bernardy@… Owned by: Fūzetsu
Priority: major Milestone: 2.15.0
Version: 2.1.0 Keywords:
Cc: pho@…, conal@…, v.dijk.bas@…, paolo.veronelli@…, felipe.lessa@…

Description

eg. this fails:

data I ev w a where

Returns
a -> I ev w a
Binds
I ev w a -> (a -> I ev w b) -> I ev w b
Gets
Ord ev => Maybe ev -> Maybe ev -> I ev w ev -- Accept any character between given bounds. Bound is ignored if @Nothing@.

Attachments

haddock-gadt.diff (2.8 kB) - added by nwf 2 years ago.
haddock-gadt-tests.diff (3.4 kB) - added by nwf 2 years ago.

Change History

  Changed 6 years ago by waern

  • milestone set to 2.3.0

This is because there's no support in the GHC parser for GADT documentation at the moment. Will try to fix this for GHC 6.10.1.

  Changed 6 years ago by anonymous

  • milestone 2.3.0 deleted

  Changed 6 years ago by waern

  • milestone set to 2.6.0

  Changed 5 years ago by waern

  • summary changed from GADT constructors can't be documented to Comments on GADT constructors
  • type changed from defect to enhancement
  • milestone changed from 2.6.0 to 2.10.0

  Changed 5 years ago by PHO

  • cc pho@… added

  Changed 4 years ago by conal

  • cc conal@… added

  Changed 4 years ago by conal

Note to future Conal: when this ticket gets resolved, fix the documentation for TV library's Input and Output GADTs.

  Changed 4 years ago by basvandijk

  • cc v.dijk.bas@… added

Note to future Bas: when this ticket gets resolved, fix the documentation in usb-safe for the GADT TransferDirection and TransferType and in explicit-iomodes and safer-file-handles for IOMode.

in reply to: ↑ description   Changed 4 years ago by paolino

  • cc paolo.veronelli@… added

Replying to jeanphilippe.bernardy@gmail.com:

eg. this fails: data I ev w a where Returns :: a -> I ev w a Binds :: I ev w a -> (a -> I ev w b) -> I ev w b Gets :: Ord ev => Maybe ev -> Maybe ev -> I ev w ev -- Accept any character between given bounds. Bound is ignored if @Nothing@.

  Changed 4 years ago by meteficha

  • cc felipe.lessa@… added

  Changed 2 years ago by anonymous

  • milestone 2.10.0 deleted

Milestone 2.10.0 deleted

Changed 2 years ago by nwf

  Changed 2 years ago by nwf

  • owner set to nwf
  • status changed from new to assigned

Please see the attached against GHC 7.6.

Changed 2 years ago by nwf

  Changed 10 months ago by mightybyte

Any status update on this? It would be nice to get docs on GADT constructors.

  Changed 8 months ago by Fūzetsu

  • owner changed from nwf to Fūzetsu
  • status changed from assigned to new
  • milestone set to 2.15.0
Note: See TracTickets for help on using tickets.