Opened 8 years ago

Closed 7 years ago

Last modified 5 years ago

#1611 closed proposal (fixed)

Data.Map, Data.IntMap documentation

Reported by: guest Owned by: igloo
Priority: normal Milestone: Not GHC
Component: libraries/base Version: 6.6.1
Keywords: Cc: apa3a@…
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: Test Case:
Blocked By: Blocking:
Related Tickets: Differential Revisions:

Description

Improved, fixed documentation for Data.Map, Data.IntMap. Moved time complexity Big-O values to the end of function descriptions. Added examples.

For the initial review I submitted only changes for Data.Map. I'll update IntMap for the final review.

Deadline - August 7, 2007 (2 weeks).
Don't worry if I don't submit the changes on the deadline. I'm frequently late with these.

Andriy

Attachments (9)

Map.diff (90.8 KB) - added by guest 8 years ago.
The diff.
Map.2.diff (47.4 KB) - added by guest 7 years ago.
Map.hs (84.2 KB) - added by guest 7 years ago.
Data-IntMap.html (87.2 KB) - added by guest 7 years ago.
Data.IntMap haddock docs
Data-Map.html (112.8 KB) - added by guest 7 years ago.
Data.Map haddock docs
IntMap.hs (65.5 KB) - added by guest 7 years ago.
Map.2.hs (84.1 KB) - added by guest 7 years ago.
patch.diff (106.5 KB) - added by guest 7 years ago.
The patch
Map.patch (43.8 KB) - added by Andriy 7 years ago.
The same patch against the trunk

Download all attachments as: .zip

Change History (17)

Changed 8 years ago by guest

The diff.

comment:1 Changed 8 years ago by igloo

  • Milestone set to Not GHC

Changed 7 years ago by guest

Changed 7 years ago by guest

Changed 7 years ago by guest

Data.IntMap haddock docs

Changed 7 years ago by guest

Data.Map haddock docs

Changed 7 years ago by guest

Changed 7 years ago by guest

Changed 7 years ago by guest

The patch

comment:2 Changed 7 years ago by igloo

  • Owner set to igloo
Thanks everybody for the corrections and suggestions.
Sorry it took this long to respond.


This is the final submission. Please commit the patch.


Log comment:
Improved, fixed documentation for Data.Map,
Data.IntMap. Added examples.

Changes since the previous submission:
* Moved time complexity Big-O values back to the
beginning of function descriptions.
* Converted examples from interpreter session-like
format to more compact equation-like format.
* As per
http://www.haskell.org/pipermail/libraries/2007-March/007304.html
added following information to the description of
updateLookupWithKey:

The function returns changed value, if it is updated.
Returns the original key value if the map entry is
deleted.

* Made corresponding changes for 
Data.IntMap.updateLookupWithKey. Mentioned that it
differs from the Data.Map version.

Ticket:
http://hackage.haskell.org/trac/ghc/ticket/1611

Andriy

comment:3 Changed 7 years ago by igloo

  • Cc apa3a@… added
  • Owner igloo deleted

This doesn't apply to the HEAD:

containers$ darcs apply < patch.diff
darcs: Cannot apply this patch bundle, since we're missing:
Tue Aug  7 19:55:57 BST 2007  Ian Lynagh <[email protected]>
  * Clarify the swapMVar haddock doc

It looks like it was made against an old checkout of the base repo?

Changed 7 years ago by Andriy

The same patch against the trunk

comment:4 Changed 7 years ago by igloo

  • Owner set to igloo

comment:5 Changed 7 years ago by igloo

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

Patch applied, thanks!

comment:6 Changed 6 years ago by simonmar

  • Architecture changed from Multiple to Unknown/Multiple

comment:7 Changed 6 years ago by simonmar

  • Operating System changed from Multiple to Unknown/Multiple

comment:8 Changed 5 years ago by simonmar

  • difficulty changed from Difficult (1 week) to Difficult (2-5 days)
Note: See TracTickets for help on using tickets.