From bfbc2898714e026a7fb58a7de78df3759c4551db Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 21 Jan 2011 09:00:05 -0800 Subject: Haddock comment improvements. --- src/Text/Pandoc/Readers/Native.hs | 3 ++- src/Text/Pandoc/Writers/Native.hs | 6 +++++- 2 files changed, 7 insertions(+), 2 deletions(-) (limited to 'src/Text/Pandoc') 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 -- cgit v1.2.3