Permalink
Browse files

DOC: Mention parseMarkupWithOptions

  • Loading branch information...
1 parent 2b91970 commit 81da1cce7b33b710054aab9adc31a65e9d6918f8 Luis Pedro Coelho committed Nov 24, 2010
Showing with 8 additions and 0 deletions.
  1. +8 −0 markup/Parse.hs
View
@@ -19,6 +19,14 @@ module Parse where
- ** Interface
-
- Main function is parseMarkup which is String -> Either ParseError Document
+ -
+ - Another function parseMarkupWithOptions allows the user to specify whether
+ - to use links and which tags should be considered block level. parseMarkup is
+ - defined as
+ -
+ - parseMarkup str = parseMarkupWithOptions (ParseOptions True ["note"]) str
+ -
+ - i.e., \b{use links} and consider \i{note} to be block level.
-}
import Markup

0 comments on commit 81da1cc

Please sign in to comment.