aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2011-01-21 09:00:05 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2011-01-21 09:00:05 -0800
commitbfbc2898714e026a7fb58a7de78df3759c4551db (patch)
treea1f150f6da6e1e989be3fc3a33a0cf9f9e7a3f49
parent9bb5b54102d06fa67961a8c344aa30d3905c3d67 (diff)
downloadpandoc-bfbc2898714e026a7fb58a7de78df3759c4551db.tar.gz
Haddock comment improvements.
-rw-r--r--src/Text/Pandoc/Readers/Native.hs3
-rw-r--r--src/Text/Pandoc/Writers/Native.hs6
2 files changed, 7 insertions, 2 deletions
diff --git a/src/Text/Pandoc/Readers/Native.hs b/src/Text/Pandoc/Readers/Native.hs
index 123ac561d..2c6fcc6e6 100644
--- a/src/Text/Pandoc/Readers/Native.hs
+++ b/src/Text/Pandoc/Readers/Native.hs
@@ -25,7 +25,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Stability : alpha
Portability : portable
-Conversion of native 'Pandoc' formatted text to a 'Pandoc' document.
+Conversion of a string representation of a pandoc type (@Pandoc@,
+@[Block]@, @Block@, @[Inline]@, or @Inline@) to a @Pandoc@ document.
-}
module Text.Pandoc.Readers.Native ( readNative ) where
diff --git a/src/Text/Pandoc/Writers/Native.hs b/src/Text/Pandoc/Writers/Native.hs
index 5f8d3e0fd..2ebe83d6b 100644
--- a/src/Text/Pandoc/Writers/Native.hs
+++ b/src/Text/Pandoc/Writers/Native.hs
@@ -26,7 +26,11 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Stability : alpha
Portability : portable
-Utility functions and definitions used by the various Pandoc modules.
+Conversion of a 'Pandoc' document to a string representation.
+
+Note: If @writerStandalone@ is @False@, only the document body
+is represented; otherwise, the full 'Pandoc' document, including the
+metadata.
-}
module Text.Pandoc.Writers.Native ( writeNative )
where