[GHC] #8712: Data.Ix missing info on row/column major indexing

[GHC]

#8712: Data.Ix missing info on row/column major indexing
-------------------------------------+-------------------------------------
       Reporter:  mirpa              |             Owner:
           Type:  bug                |            Status:  new
       Priority:  normal             |         Milestone:
      Component:  libraries/base     |           Version:  7.6.3
       Keywords:  row, column,       |  Operating System:  Unknown/Multiple
  major, Ix                          |   Type of failure:  Documentation
   Architecture:  Unknown/Multiple   |  bug
     Difficulty:  Easy (less than 1  |         Test Case:
  hour)                              |          Blocking:
     Blocked By:                     |
Related Tickets:                     |
-------------------------------------+-------------------------------------
 I've tried to use {{{Data.Ix}}} with {{{Data.Vector}}} for image
 manipulations and I confused column with row-major indexing.

 I expected than {{{Data.Ix.index ((0,0),(3,3)) (1,0) == 1}}} while it is
 actually equal to 4.

 Documentation for {{{Data.Ix}}} should explicitly state that it is row-
 major indexing and function {{{Data.Ix.index}}} might be accompanied by
 example like: {{{index ((0,0),(3,3)) (1,0) == 4}}} which should be
 obvious.

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/8712>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler