aboutsummaryrefslogtreecommitdiffhomepage
path: root/libs/markdown/extensions/nl2br.py
diff options
context:
space:
mode:
Diffstat (limited to 'libs/markdown/extensions/nl2br.py')
-rw-r--r--libs/markdown/extensions/nl2br.py28
1 files changed, 18 insertions, 10 deletions
diff --git a/libs/markdown/extensions/nl2br.py b/libs/markdown/extensions/nl2br.py
index 6c7491bca..177df1ee4 100644
--- a/libs/markdown/extensions/nl2br.py
+++ b/libs/markdown/extensions/nl2br.py
@@ -1,21 +1,28 @@
-"""
-NL2BR Extension
-===============
+# `NL2BR` Extension
+# ===============
-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; like
+# GitHub-flavored Markdown does.
+
+# See https://Python-Markdown.github.io/extensions/nl2br
+# for documentation.
-See <https://Python-Markdown.github.io/extensions/nl2br>
-for documentation.
+# Original code Copyright 2011 [Brian Neal](https://deathofagremmie.com/)
-Oringinal code Copyright 2011 [Brian Neal](https://deathofagremmie.com/)
+# All changes Copyright 2011-2014 The Python Markdown Project
-All changes Copyright 2011-2014 The Python Markdown Project
+# License: [BSD](https://opensource.org/licenses/bsd-license.php)
-License: [BSD](https://opensource.org/licenses/bsd-license.php)
+"""
+A Python-Markdown extension to treat newlines as hard breaks; like
+GitHub-flavored Markdown does.
+See the [documentation](https://Python-Markdown.github.io/extensions/nl2br)
+for details.
"""
+from __future__ import annotations
+
from . import Extension
from ..inlinepatterns import SubstituteTagInlineProcessor
@@ -25,6 +32,7 @@ BR_RE = r'\n'
class Nl2BrExtension(Extension):
def extendMarkdown(self, md):
+ """ Add a `SubstituteTagInlineProcessor` to Markdown. """
br_tag = SubstituteTagInlineProcessor(BR_RE, 'br')
md.inlinePatterns.register(br_tag, 'nl', 5)