From b18ff62a61adf43798ae7a05c7c40ce9aea4c50d Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Tue, 24 Dec 2024 13:04:23 -0500 Subject: [PATCH 1/3] Remove link from doc summary --- markdown/extensions/admonition.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/markdown/extensions/admonition.py b/markdown/extensions/admonition.py index 01c2316d2..edfeb4964 100644 --- a/markdown/extensions/admonition.py +++ b/markdown/extensions/admonition.py @@ -16,7 +16,8 @@ """ -Adds rST-style admonitions. Inspired by [rST][] feature with the same name. +Adds rST-style admonitions to Python-Markdown. +Inspired by [rST][] feature with the same name. [rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions From f502866f8ce74f615d2337506b171b86306759ea Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Tue, 24 Dec 2024 13:18:49 -0500 Subject: [PATCH 2/3] Clean up module summaries --- markdown/extensions/attr_list.py | 3 ++- markdown/extensions/md_in_html.py | 4 ++-- markdown/extensions/nl2br.py | 4 ++-- markdown/extensions/smarty.py | 3 +-- markdown/extensions/tables.py | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/markdown/extensions/attr_list.py b/markdown/extensions/attr_list.py index 9206d11e6..d0d6aaf04 100644 --- a/markdown/extensions/attr_list.py +++ b/markdown/extensions/attr_list.py @@ -15,7 +15,8 @@ # License: [BSD](https://opensource.org/licenses/bsd-license.php) """ - Adds attribute list syntax. Inspired by +Adds attribute list syntax to Python-Markdown. +Inspired by [Maruku](http://maruku.rubyforge.org/proposal.html#attribute_lists)'s feature of the same name. diff --git a/markdown/extensions/md_in_html.py b/markdown/extensions/md_in_html.py index 64b84a5f4..c162c9b3f 100644 --- a/markdown/extensions/md_in_html.py +++ b/markdown/extensions/md_in_html.py @@ -12,8 +12,8 @@ # License: [BSD](https://opensource.org/licenses/bsd-license.php) """ -An implementation of [PHP Markdown Extra](http://michelf.com/projects/php-markdown/extra/)'s -parsing of Markdown syntax in raw HTML. +Parse Markdown syntax within raw HTML. +Based on the implementation in [PHP Markdown Extra](http://michelf.com/projects/php-markdown/extra/). See the [documentation](https://Python-Markdown.github.io/extensions/raw_html) for details. diff --git a/markdown/extensions/nl2br.py b/markdown/extensions/nl2br.py index 177df1ee4..d47292025 100644 --- a/markdown/extensions/nl2br.py +++ b/markdown/extensions/nl2br.py @@ -14,8 +14,8 @@ # License: [BSD](https://opensource.org/licenses/bsd-license.php) """ -A Python-Markdown extension to treat newlines as hard breaks; like -GitHub-flavored Markdown does. +A Python-Markdown extension to treat newlines as hard breaks. +Similar to GitHub-flavored Markdown's behavior. See the [documentation](https://Python-Markdown.github.io/extensions/nl2br) for details. diff --git a/markdown/extensions/smarty.py b/markdown/extensions/smarty.py index 7a7c952dc..d669e69b0 100644 --- a/markdown/extensions/smarty.py +++ b/markdown/extensions/smarty.py @@ -77,8 +77,7 @@ # of this software, even if advised of the possibility of such damage. """ -Adds conversion of ASCII dashes, quotes and ellipses to their HTML -entity equivalents. +Convert ASCII dashes, quotes and ellipses to their HTML entity equivalents. See the [documentation](https://Python-Markdown.github.io/extensions/smarty) for details. diff --git a/markdown/extensions/tables.py b/markdown/extensions/tables.py index 6e2fa1742..f405e35cd 100644 --- a/markdown/extensions/tables.py +++ b/markdown/extensions/tables.py @@ -1,7 +1,7 @@ # Tables Extension for Python-Markdown # ==================================== -# Added parsing of tables to Python-Markdown. +# Adds parsing of tables to Python-Markdown. # See https://Python-Markdown.github.io/extensions/tables # for documentation. @@ -13,7 +13,7 @@ # License: [BSD](https://opensource.org/licenses/bsd-license.php) """ -Added parsing of tables to Python-Markdown. +Adds parsing of tables to Python-Markdown. See the [documentation](https://Python-Markdown.github.io/extensions/tables) for details. From 79aa27364d2770564afe0d105c15ef9985ed1746 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Tue, 24 Dec 2024 13:22:06 -0500 Subject: [PATCH 3/3] cleanup --- markdown/extensions/attr_list.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/markdown/extensions/attr_list.py b/markdown/extensions/attr_list.py index d0d6aaf04..3bbcaee16 100644 --- a/markdown/extensions/attr_list.py +++ b/markdown/extensions/attr_list.py @@ -15,7 +15,7 @@ # License: [BSD](https://opensource.org/licenses/bsd-license.php) """ -Adds attribute list syntax to Python-Markdown. +Adds attribute list syntax to Python-Markdown. Inspired by [Maruku](http://maruku.rubyforge.org/proposal.html#attribute_lists)'s feature of the same name.