encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-13 05:06:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

substitute '@@' code block delimiter with triple backtick, more con… (#5513)

Browse Source 
* substitute '@@' code block delimiter with triple back-tick,  more consistent with other markdown extensions

* remove development print and allow spaces between triple backtick and syntax name in codeblock

* update comparison content for markdown test
This commit is contained in:
Matteo Nastasi 2017-10-20 11:39:29 +02:00 committed by Carlton Gibson
parent 22a71a6322
commit 9ec81e32da
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
rest_framework/compat.py
View File

@ -244,7 +244,7 @@ if markdown is not None and pygments is not None:
class CodeBlockPreprocessor(Preprocessor): class CodeBlockPreprocessor(Preprocessor):
pattern = re.compile( pattern = re.compile(
r'^\s*@@ (.+?) @@\s*(.+?)^\s*@@', re.M|re.S) r'^\s*``` *([^\n]+)\n(.+?)^\s*```', re.M|re.S)
formatter = HtmlFormatter() formatter = HtmlFormatter()

22
tests/test_description.py
View File

@ -26,12 +26,12 @@ indented
# hash style header # # hash style header #
@@ json @@ ``` json
[{ [{
"alpha": 1, "alpha": 1,
"beta: "this is a string" "beta: "this is a string"
}] }]
@@""" ```"""
# If markdown is installed we also test it's working # If markdown is installed we also test it's working
# (and that our wrapped forces '=' to h2 and '-' to h3) # (and that our wrapped forces '=' to h2 and '-' to h3)
@ -47,12 +47,11 @@ string&quot;</span><br /><span class="p">}]</span><br /></pre></div>
<p><br /></p>""" <p><br /></p>"""
MARKED_DOWN_NOT_HILITE = """ MARKED_DOWN_NOT_HILITE = """
<p>@@ json @@ <p><code>json
[{ [{
"alpha": 1, "alpha": 1,
"beta: "this is a string" "beta: "this is a string"
}] }]</code></p>"""
@@</p>"""
# We support markdown < 2.1 and markdown >= 2.1 # We support markdown < 2.1 and markdown >= 2.1
MARKED_DOWN_lt_21 = """<h2>an example docstring</h2> MARKED_DOWN_lt_21 = """<h2>an example docstring</h2>
@ -105,12 +104,12 @@ class TestViewNamesAndDescriptions(TestCase):
# hash style header # # hash style header #
@@ json @@ ``` json
[{ [{
"alpha": 1, "alpha": 1,
"beta: "this is a string" "beta: "this is a string"
}] }]
@@""" ```"""
assert MockView().get_view_description() == DESCRIPTION assert MockView().get_view_description() == DESCRIPTION
@ -150,15 +149,16 @@ class TestViewNamesAndDescriptions(TestCase):
Ensure markdown to HTML works as expected. Ensure markdown to HTML works as expected.
""" """
if apply_markdown: if apply_markdown:
md_applied = apply_markdown(DESCRIPTION)
gte_21_match = ( gte_21_match = (
apply_markdown(DESCRIPTION) == ( md_applied == (
MARKED_DOWN_gte_21 % MARKED_DOWN_HILITE) or MARKED_DOWN_gte_21 % MARKED_DOWN_HILITE) or
apply_markdown(DESCRIPTION) == ( md_applied == (
MARKED_DOWN_gte_21 % MARKED_DOWN_NOT_HILITE)) MARKED_DOWN_gte_21 % MARKED_DOWN_NOT_HILITE))
lt_21_match = ( lt_21_match = (
apply_markdown(DESCRIPTION) == ( md_applied == (
MARKED_DOWN_lt_21 % MARKED_DOWN_HILITE) or MARKED_DOWN_lt_21 % MARKED_DOWN_HILITE) or
apply_markdown(DESCRIPTION) == ( md_applied == (
MARKED_DOWN_lt_21 % MARKED_DOWN_NOT_HILITE)) MARKED_DOWN_lt_21 % MARKED_DOWN_NOT_HILITE))
assert gte_21_match or lt_21_match assert gte_21_match or lt_21_match