Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 4260e7b

Browse files
authored
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 #1495.
1 parent 7aace29 commit 4260e7b

File tree

6 files changed

+11
-10
lines changed

6 files changed

+11
-10
lines changed

‎markdown/extensions/admonition.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616

1717

1818
"""
19-
Adds rST-style admonitions. Inspired by [rST][] feature with the same name.
19+
Adds rST-style admonitions to Python-Markdown.
20+
Inspired by [rST][] feature with the same name.
2021
2122
[rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions
2223

‎markdown/extensions/attr_list.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
# License: [BSD](https://opensource.org/licenses/bsd-license.php)
1616

1717
"""
18-
Adds attribute list syntax. Inspired by
18+
Adds attribute list syntax to Python-Markdown.
19+
Inspired by
1920
[Maruku](http://maruku.rubyforge.org/proposal.html#attribute_lists)'s
2021
feature of the same name.
2122

‎markdown/extensions/md_in_html.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
# License: [BSD](https://opensource.org/licenses/bsd-license.php)
1313

1414
"""
15-
An implementation of [PHP Markdown Extra](http://michelf.com/projects/php-markdown/extra/)'s
16-
parsing of Markdown syntax in raw HTML.
15+
Parse Markdown syntax within raw HTML.
16+
Based on the implementation in [PHP Markdown Extra](http://michelf.com/projects/php-markdown/extra/).
1717
1818
See the [documentation](https://Python-Markdown.github.io/extensions/raw_html)
1919
for details.

‎markdown/extensions/nl2br.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
# License: [BSD](https://opensource.org/licenses/bsd-license.php)
1515

1616
"""
17-
A Python-Markdown extension to treat newlines as hard breaks; like
18-
GitHub-flavored Markdown does.
17+
A Python-Markdown extension to treat newlines as hard breaks.
18+
Similar to GitHub-flavored Markdown's behavior.
1919
2020
See the [documentation](https://Python-Markdown.github.io/extensions/nl2br)
2121
for details.

‎markdown/extensions/smarty.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@
7777
# of this software, even if advised of the possibility of such damage.
7878

7979
"""
80-
Adds conversion of ASCII dashes, quotes and ellipses to their HTML
81-
entity equivalents.
80+
Convert ASCII dashes, quotes and ellipses to their HTML entity equivalents.
8281
8382
See the [documentation](https://Python-Markdown.github.io/extensions/smarty)
8483
for details.

‎markdown/extensions/tables.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Tables Extension for Python-Markdown
22
# ====================================
33

4-
# Added parsing of tables to Python-Markdown.
4+
# Adds parsing of tables to Python-Markdown.
55

66
# See https://Python-Markdown.github.io/extensions/tables
77
# for documentation.
@@ -13,7 +13,7 @@
1313
# License: [BSD](https://opensource.org/licenses/bsd-license.php)
1414

1515
"""
16-
Added parsing of tables to Python-Markdown.
16+
Adds parsing of tables to Python-Markdown.
1717
1818
See the [documentation](https://Python-Markdown.github.io/extensions/tables)
1919
for details.

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /