👌 IMPROVE: Add bullet attribute to bullet_list node (#465)

chrisjsewell · web-flow · commit b7ab7fc4b57d · 2021-12-16T13:59:55.000+01:00
This brings it inline with the AST produced by RST
diff --git a/myst_parser/docutils_renderer.py b/myst_parser/docutils_renderer.py
@@ -365,6 +365,8 @@ def render_text(self, token: SyntaxTreeNode) -> None:
 
     def render_bullet_list(self, token: SyntaxTreeNode) -> None:
         list_node = nodes.bullet_list()
+        if token.markup:
+            list_node["bullet"] = token.markup
         if token.attrs.get("class"):
             # this is used e.g. by tasklist
             list_node["classes"] = str(token.attrs["class"]).split()
diff --git a/tests/test_renderers/fixtures/amsmath.md b/tests/test_renderers/fixtures/amsmath.md
@@ -46,7 +46,7 @@ In list:
   \end{equation}
 .
 <document source="notset">
-    <bullet_list>
+    <bullet_list bullet="-">
         <list_item>
             <target ids="equation-mock-uuid">
             <math_block classes="amsmath" docname="mock_docname" label="mock-uuid" nowrap="True" number="1" xml:space="preserve">
diff --git a/tests/test_renderers/fixtures/sphinx_directives.md b/tests/test_renderers/fixtures/sphinx_directives.md
@@ -172,7 +172,7 @@ acks (`sphinx.directives.other.Acks`):
 .
 <document source="notset">
     <acks>
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     name
diff --git a/tests/test_renderers/fixtures/syntax_elements.md b/tests/test_renderers/fixtures/syntax_elements.md
@@ -213,13 +213,18 @@ Block Quote:
 Bullet List:
 .
 - *foo*
+* bar
 .
 <document source="notset">
-    <bullet_list>
+    <bullet_list bullet="-">
         <list_item>
             <paragraph>
                 <emphasis>
                     foo
+    <bullet_list bullet="*">
+        <list_item>
+            <paragraph>
+                bar
 .
 
 --------------------------
@@ -231,15 +236,15 @@ Nested Bullets
   - d
 .
 <document source="notset">
-    <bullet_list>
+    <bullet_list bullet="-">
         <list_item>
             <paragraph>
                 a
-            <bullet_list>
+            <bullet_list bullet="-">
                 <list_item>
                     <paragraph>
                         b
-                    <bullet_list>
+                    <bullet_list bullet="-">
                         <list_item>
                             <paragraph>
                                 c
@@ -601,7 +606,7 @@ finish
         <block_quote>
             <paragraph>
                 a
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     b
diff --git a/tests/test_sphinx/test_sphinx_builds/test_basic.resolved.sphinx3.xml b/tests/test_sphinx/test_sphinx_builds/test_basic.resolved.sphinx3.xml
@@ -107,17 +107,17 @@
             a comment 2
         <paragraph>
             this is a second paragraph
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     a list
-                <bullet_list>
+                <bullet_list bullet="-">
                     <list_item>
                         <paragraph>
                             a sub list
         <comment xml:space="preserve">
             a comment 3
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     new list?
diff --git a/tests/test_sphinx/test_sphinx_builds/test_basic.resolved.sphinx4.xml b/tests/test_sphinx/test_sphinx_builds/test_basic.resolved.sphinx4.xml
@@ -107,17 +107,17 @@
             a comment 2
         <paragraph>
             this is a second paragraph
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     a list
-                <bullet_list>
+                <bullet_list bullet="-">
                     <list_item>
                         <paragraph>
                             a sub list
         <comment xml:space="preserve">
             a comment 3
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     new list?
diff --git a/tests/test_sphinx/test_sphinx_builds/test_basic.sphinx3.xml b/tests/test_sphinx/test_sphinx_builds/test_basic.sphinx3.xml
@@ -108,17 +108,17 @@
             a comment 2
         <paragraph>
             this is a second paragraph
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     a list
-                <bullet_list>
+                <bullet_list bullet="-">
                     <list_item>
                         <paragraph>
                             a sub list
         <comment xml:space="preserve">
             a comment 3
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     new list?
diff --git a/tests/test_sphinx/test_sphinx_builds/test_basic.sphinx4.xml b/tests/test_sphinx/test_sphinx_builds/test_basic.sphinx4.xml
@@ -108,17 +108,17 @@
             a comment 2
         <paragraph>
             this is a second paragraph
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     a list
-                <bullet_list>
+                <bullet_list bullet="-">
                     <list_item>
                         <paragraph>
                             a sub list
         <comment xml:space="preserve">
             a comment 3
-        <bullet_list>
+        <bullet_list bullet="-">
             <list_item>
                 <paragraph>
                     new list?
diff --git a/tests/test_sphinx/test_sphinx_builds/test_extended_syntaxes.sphinx3.xml b/tests/test_sphinx/test_sphinx_builds/test_extended_syntaxes.sphinx3.xml
@@ -73,7 +73,7 @@
             linkify URL: 
             <reference refuri="http://www.example.com">
                 www.example.com
-        <bullet_list classes="contains-task-list">
+        <bullet_list bullet="-" classes="contains-task-list">
             <list_item classes="task-list-item">
                 <paragraph>
                     <raw format="html" xml:space="preserve">
diff --git a/tests/test_sphinx/test_sphinx_builds/test_extended_syntaxes.sphinx4.xml b/tests/test_sphinx/test_sphinx_builds/test_extended_syntaxes.sphinx4.xml
@@ -73,7 +73,7 @@
             linkify URL: 
             <reference refuri="http://www.example.com">
                 www.example.com
-        <bullet_list classes="contains-task-list">
+        <bullet_list bullet="-" classes="contains-task-list">
             <list_item classes="task-list-item">
                 <paragraph>
                     <raw format="html" xml:space="preserve">
diff --git a/tests/test_sphinx/test_sphinx_builds/test_footnotes.xml b/tests/test_sphinx/test_sphinx_builds/test_footnotes.xml
@@ -25,7 +25,7 @@
             <footnote_reference auto="1" docname="footnote_md" ids="id7" refid="e">
                 5
         <block_quote>
-            <bullet_list>
+            <bullet_list bullet="-">
                 <list_item>
         <transition classes="footnotes">
         <footnote auto="1" backrefs="id1" docname="footnote_md" ids="c" names="c">
diff --git a/tests/test_sphinx/test_sphinx_builds/test_gettext_html.resolved.sphinx3.xml b/tests/test_sphinx/test_sphinx_builds/test_gettext_html.resolved.sphinx3.xml
@@ -18,7 +18,7 @@
                 texte 4 en 
                 <strong>
                     gras
-        <bullet_list>
+        <bullet_list bullet="*">
             <list_item>
                 <paragraph>
                     texte 5 en 
diff --git a/tests/test_sphinx/test_sphinx_builds/test_gettext_html.resolved.sphinx4.xml b/tests/test_sphinx/test_sphinx_builds/test_gettext_html.resolved.sphinx4.xml
@@ -18,7 +18,7 @@
                 texte 4 en 
                 <strong>
                     gras
-        <bullet_list>
+        <bullet_list bullet="*">
             <list_item>
                 <paragraph>
                     texte 5 en 
diff --git a/tests/test_sphinx/test_sphinx_builds/test_gettext_html.sphinx3.xml b/tests/test_sphinx/test_sphinx_builds/test_gettext_html.sphinx3.xml
@@ -18,7 +18,7 @@
                 texte 4 en 
                 <strong>
                     gras
-        <bullet_list>
+        <bullet_list bullet="*">
             <list_item>
                 <paragraph>
                     texte 5 en 
diff --git a/tests/test_sphinx/test_sphinx_builds/test_gettext_html.sphinx4.xml b/tests/test_sphinx/test_sphinx_builds/test_gettext_html.sphinx4.xml
@@ -18,7 +18,7 @@
                 texte 4 en 
                 <strong>
                     gras
-        <bullet_list>
+        <bullet_list bullet="*">
             <list_item>
                 <paragraph>
                     texte 5 en 

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ In list:`
`46`	`46`	`\end{equation}`
`47`	`47`	`.`
`48`	`48`	`<document source="notset">`
`49`		`- <bullet_list>`
	`49`	`+ <bullet_list bullet="-">`
`50`	`50`	`<list_item>`
`51`	`51`	`<target ids="equation-mock-uuid">`
`52`	`52`	`<math_block classes="amsmath" docname="mock_docname" label="mock-uuid" nowrap="True" number="1" xml:space="preserve">`
Original file line number	Diff line number	Diff line change
@@ -172,7 +172,7 @@ acks (`sphinx.directives.other.Acks`):
`172`	`172`	`.`
`173`	`173`	`<document source="notset">`
`174`	`174`	`<acks>`
`175`		`- <bullet_list>`
	`175`	`+ <bullet_list bullet="-">`
`176`	`176`	`<list_item>`
`177`	`177`	`<paragraph>`
`178`	`178`	`name`
Original file line number	Diff line number	Diff line change
`@@ -213,13 +213,18 @@ Block Quote:`
`213`	`213`	`Bullet List:`
`214`	`214`	`.`
`215`	`215`	`- foo`
	`216`	`+* bar`
`216`	`217`	`.`
`217`	`218`	`<document source="notset">`
`218`		`- <bullet_list>`
	`219`	`+ <bullet_list bullet="-">`
`219`	`220`	`<list_item>`
`220`	`221`	`<paragraph>`
`221`	`222`	`<emphasis>`
`222`	`223`	`foo`
	`224`	`+ <bullet_list bullet="*">`
	`225`	`+ <list_item>`
	`226`	`+ <paragraph>`
	`227`	`+ bar`
`223`	`228`	`.`
`224`	`229`
`225`	`230`	`--------------------------`
`@@ -231,15 +236,15 @@ Nested Bullets`
`231`	`236`	`- d`
`232`	`237`	`.`
`233`	`238`	`<document source="notset">`
`234`		`- <bullet_list>`
	`239`	`+ <bullet_list bullet="-">`
`235`	`240`	`<list_item>`
`236`	`241`	`<paragraph>`
`237`	`242`	`a`
`238`		`- <bullet_list>`
	`243`	`+ <bullet_list bullet="-">`
`239`	`244`	`<list_item>`
`240`	`245`	`<paragraph>`
`241`	`246`	`b`
`242`		`- <bullet_list>`
	`247`	`+ <bullet_list bullet="-">`
`243`	`248`	`<list_item>`
`244`	`249`	`<paragraph>`
`245`	`250`	`c`
`@@ -601,7 +606,7 @@ finish`
`601`	`606`	`<block_quote>`
`602`	`607`	`<paragraph>`
`603`	`608`	`a`
`604`		`- <bullet_list>`
	`609`	`+ <bullet_list bullet="-">`
`605`	`610`	`<list_item>`
`606`	`611`	`<paragraph>`
`607`	`612`	`b`