Package: libtext-multimarkdown-perl Version: 1.000035-1 Severity: wishlist Tags: upstream patch
Hi! I've found some problems with the docs, attached two patches fixing them. Thanks, Guillem
From 12dcd7e96b86a6a00621fe295a3bdcde92538c03 Mon Sep 17 00:00:00 2001 From: Guillem Jover <[email protected]> Date: Fri, 17 Jul 2015 17:38:43 +0200 Subject: [PATCH 1/2] Update github project URL --- lib/Text/MultiMarkdown.pm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/Text/MultiMarkdown.pm b/lib/Text/MultiMarkdown.pm index dc9f10b..b4e5d79 100644 --- a/lib/Text/MultiMarkdown.pm +++ b/lib/Text/MultiMarkdown.pm @@ -1354,8 +1354,8 @@ please report them as bugs. =head1 SOURCE CODE -You can find the source code repository for L<Text::Markdown> and L<Text::MultiMarkdown> -on GitHub at <http://github.com/bobtfish/text-markdown>. +You can find the source code repository for L<Text::MultiMarkdown> +on GitHub at <http://github.com/bobtfish/text-multimarkdown>. =head1 COPYRIGHT AND LICENSE -- 2.4.3.573.g4eafbef
From 8cc3c330d093c681bdfaa099a4740dcbbb2f1018 Mon Sep 17 00:00:00 2001 From: Guillem Jover <[email protected]> Date: Fri, 17 Jul 2015 17:53:22 +0200 Subject: [PATCH 2/2] Improve options documentation Document the use_metadata option default. Add missing underscores to the empty_element_suffix option. And correct format metadata option. --- lib/Text/MultiMarkdown.pm | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/Text/MultiMarkdown.pm b/lib/Text/MultiMarkdown.pm index b4e5d79..0bae432 100644 --- a/lib/Text/MultiMarkdown.pm +++ b/lib/Text/MultiMarkdown.pm @@ -92,13 +92,13 @@ The options for the processor are: =item use_metadata -Controls the metadata options below. +Controls the metadata options below. Defaults to true. =item strip_metadata If true, any metadata in the input document is removed from the output document (note - does not take effect in complete document format). -=item empty element suffix +=item empty_element_suffix This option can be used to generate normal HTML output. By default, it is ' />', which is xHTML, change to '>' for normal HTML. @@ -170,9 +170,10 @@ A list of 'known' metadata keys, and their effects are listed below: =over -=item document format +=item format -If set to 'complete', MultiMarkdown will render an entire xHTML page, otherwise it will render a document fragment +Maps to the option document_format. If set to 'complete', MultiMarkdown will +render an entire xHTML page, otherwise it will render a document fragment. =over -- 2.4.3.573.g4eafbef
