| Copyright | (c) 2003 Graham Klyne 2009 Vasili I Galchin 2011 2012 Douglas Burke |
|---|---|
| License | GPL V2 |
| Maintainer | Douglas Burke |
| Stability | experimental |
| Portability | H98 |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Data.String.ShowLines
Description
This module defines an extension of the Show class for displaying
multi-line values. It serves the following purposes:
Documentation
class Show sh => ShowLines sh where Source #
ShowLines is a type class for values that may be formatted in multi-line displays.
Minimal complete definition
Nothing
Methods
showls :: String -> sh -> ShowS Source #
Multi-line value display method
Create a multiline displayable form of a value, returned
as a ShowS value. The default implementation behaves just
like a normal instance of Show.
This function is intended to allow the calling function some control of multiline displays by providing:
- the first line of the value is not preceded by any text, so it may be appended to some preceding text on the same line,
- the supplied line break string is used to separate lines of the formatted text, and may include any desired indentation, and
- no newline is output following the final line of text.