Clean up module summaries for API docs

First line of module docstring is used as summary of module. Therefore, first line should only contain a full sentence and no incomplete links. Fixes Python-Markdown#1495.
waylan · Dec 24, 2024 · 4260e7b · 4260e7b
1 parent 7aace29
commit 4260e7b
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 10 deletions.
diff --git 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
 

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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.