documentation/python: verify that HTML escaping is done for pybind as well.

It is, even though I felt like it wasn't. Good to have to avoid
double-escaping accidents in the future.

diff --git a/documentation/test_python/pybind_signatures/pybind_signatures.cpp b/documentation/test_python/pybind_signatures/pybind_signatures.cpp
index 62a9f655f7c4bf7217922a80597c3778a3b8e135..a982f2b1f5af5a5f150faf8aa2c8a1ca59aa0ebe 100644 (file)
--- a/documentation/test_python/pybind_signatures/pybind_signatures.cpp
+++ b/documentation/test_python/pybind_signatures/pybind_signatures.cpp
@@ -63,6 +63,8 @@ PYBIND11_MODULE(pybind_signatures, m) {
         .def("duck", &duck, "A function taking args/kwargs directly")
         .def("takes_a_function", &takesAFunction, "A function taking a Callable")
         .def("takes_a_function_returning_none", &takesAFunctionReturningVoid, "A function taking a Callable that returns None")
+        .def("escape_docstring", &voidFunction, "A docstring that <em>should</em> be escaped")
+        .def("failed_parse_docstring", &crazySignature, "A failed parse should <strong>also</strong> escape the docstring")
 
         .def("tenOverloads", &tenOverloads<float, float>, "Ten overloads of a function")
         .def("tenOverloads", &tenOverloads<int, float>, "Ten overloads of a function")

diff --git a/documentation/test_python/pybind_signatures/pybind_signatures.html b/documentation/test_python/pybind_signatures/pybind_signatures.html
index 43fd799a45d0882b79316756c45d26d3bbf6a2a4..2ff53e0701d92ef425612fb11bc3a0f8dbd6840a 100644 (file)
--- a/documentation/test_python/pybind_signatures/pybind_signatures.html
+++ b/documentation/test_python/pybind_signatures/pybind_signatures.html
@@ -55,6 +55,14 @@
               <span class="m-doc-wrap-bumper">def <a href="#duck-9024d" class="m-doc-self">duck</a>(</span><span class="m-doc-wrap">*args, **kwargs) -&gt; None</span>
             </dt>
             <dd>A function taking args/kwargs directly</dd>
+            <dt id="escape_docstring-46f8a">
+              <span class="m-doc-wrap-bumper">def <a href="#escape_docstring-46f8a" class="m-doc-self">escape_docstring</a>(</span><span class="m-doc-wrap">arg0: int<span class="m-text m-dim">, /</span>) -&gt; None</span>
+            </dt>
+            <dd>A docstring that &lt;em&gt;should&lt;/em&gt; be escaped</dd>
+            <dt id="failed_parse_docstring-6eef6">
+              <span class="m-doc-wrap-bumper">def <a href="#failed_parse_docstring-6eef6" class="m-doc-self">failed_parse_docstring</a>(</span><span class="m-doc-wrap">…)</span>
+            </dt>
+            <dd>A failed parse should &lt;strong&gt;also&lt;/strong&gt; escape the docstring</dd>
             <dt id="overloaded-46f8a">
               <span class="m-doc-wrap-bumper">def <a href="#overloaded-46f8a" class="m-doc-self">overloaded</a>(</span><span class="m-doc-wrap">arg0: int<span class="m-text m-dim">, /</span>) -&gt; str</span>
             </dt>