Changeset 197 for docs/trunk/hacking-guide
- Timestamp:
- Jan 28, 2008, 1:38:00 PM (18 years ago)
- Author:
- neil.c.c.brown
- Message:
-
Added a note about always using the 6.6 library documentation, and provided URLs for that version of the useful modules
- File:
-
- 1 edited
- docs/trunk/hacking-guide/tock-intro.tex (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
docs/trunk/hacking-guide/tock-intro.tex
r196 r197 521 521 The Utils (and to a lesser extent TestUtils) module are intended to contain functions that could have 522 522 come straight out of the standard library. The standard library is also another place to look for 523 useful functions. The URL for the latest version is: \url{http://haskell.org/ghc/docs/latest/html/libraries/}. 524 Particularly useful modules are\footnote{The URLs are a bit fragile for the latest version, but 525 they are easy enough to find by searching the contents page at the URL given above}: 523 useful functions. The URL for the latest version is: \url{http://haskell.org/ghc/docs/6.6/html/libraries/}. 524 Make sure you always refer to the documentation for the lowest compiler version we support (currently 525 6.6) to avoid accidentally using a function that is only available in a later version. 526 527 Particularly useful modules are: 526 528 527 529 \begin{itemize} 528 \item \lstinline|Data.List| -- Contains various helper functions for dealing with lists, including map, 530 \item \href{http://haskell.org/ghc/docs/6.6/html/libraries/base/Data-List.html}{\lstinline|Data.List|} 531 -- Contains various helper functions for dealing with lists, including map, 529 532 foldl, zip, sum, and many others\footnote{A lot of these are technically in the standard Prelude, but 530 533 it's easy to find all the documentation in one place in the \lstinline|Data.List| module, as well 531 534 as several useful functions not in the Prelude.}. Probably the most useful module. 532 \item \lstinline|Control.Monad| -- Contains all the general monadic helper functions, such as 535 \item \href{http://haskell.org/ghc/docs/6.6/html/libraries/base/Control-Monad.html}{\lstinline|Control.Monad|} 536 -- Contains all the general monadic helper functions, such as 533 537 mapM, foldM, sequence. If you ever find yourself struggling to manipulate monadic types, there 534 538 may be something to help you in here. 535 \item \lstinline|System.IO| -- Contains all the functions for printing to the screen, reading from 539 \item \href{http://haskell.org/ghc/docs/6.6/html/libraries/base/Control-Monad.html}{\lstinline|System.IO|} 540 -- Contains all the functions for printing to the screen, reading from 536 541 files, etc. 537 542 \end{itemize} 538 543 539 Other useful modules are \lstinline|Data.Maybe|, \lstinline|Data.Generics|, \lstinline|Data.Map|, 540 \lstinline|Data.Set| and \lstinline|Test.HUnit|. 544 Other useful modules are 545 \href{http://haskell.org/ghc/docs/6.6/html/libraries/base/Data-Maybe.html}{\lstinline|Data.Maybe|}, 546 \href{http://haskell.org/ghc/docs/6.6/html/libraries/base/Data-Generics.html}{\lstinline|Data.Generics|}, 547 \href{http://haskell.org/ghc/docs/6.6/html/libraries/base/Data-Map.html}{\lstinline|Data.Map|}, 548 \href{http://haskell.org/ghc/docs/6.6/html/libraries/base/Data-Set.html}{\lstinline|Data.Set|} and 549 \href{http://haskell.org/ghc/docs/6.6/html/libraries/HUnit/Test-HUnit.html}{\lstinline|Test.HUnit|}. 541 550 542 551 \section{Test Your Code}
Note:
See TracChangeset
for help on using the changeset viewer.