From: Vladimír Vondruš <mosra@centrum.cz>
Date: Wed, 5 Jan 2022 21:26:44 +0000 (+0100)
Subject: documentation/python: add a test with full pybind11 docstrings.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=63baae238730bb81b6ab4b9cd8580ade4fe01e95;p=blog.git

documentation/python: add a test with full pybind11 docstrings.

Those get currently ignored.
---

diff --git a/documentation/test_python/pybind_signatures/pybind_signatures.cpp b/documentation/test_python/pybind_signatures/pybind_signatures.cpp
index a982f2b1..e6934b3f 100644
--- a/documentation/test_python/pybind_signatures/pybind_signatures.cpp
+++ b/documentation/test_python/pybind_signatures/pybind_signatures.cpp
@@ -75,7 +75,11 @@ PYBIND11_MODULE(pybind_signatures, m) {
         .def("tenOverloads", &tenOverloads<float, bool>, "Ten overloads of a function")
         .def("tenOverloads", &tenOverloads<int, bool>, "Ten overloads of a function")
         .def("tenOverloads", &tenOverloads<bool, bool>, "Ten overloads of a function")
-        .def("tenOverloads", &tenOverloads<std::string, std::string>, "Ten overloads of a function");
+        .def("tenOverloads", &tenOverloads<std::string, std::string>, "Ten overloads of a function")
+
+        .def("full_docstring", &voidFunction, R"(A summary
+
+And a larger docstring as well, which is currently ignored.)");
 
     py::class_<MyClass>(m, "MyClass", "My fun class!")
         .def_static("static_function", &MyClass::staticFunction, "Static method with positional-only args")
diff --git a/documentation/test_python/pybind_signatures/pybind_signatures.html b/documentation/test_python/pybind_signatures/pybind_signatures.html
index f844969e..19c79b1b 100644
--- a/documentation/test_python/pybind_signatures/pybind_signatures.html
+++ b/documentation/test_python/pybind_signatures/pybind_signatures.html
@@ -63,6 +63,10 @@
               <span class="m-doc-wrap-bumper">def <a href="#failed_parse_docstring" 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="full_docstring">
+              <span class="m-doc-wrap-bumper">def <a href="#full_docstring" class="m-doc-self">full_docstring</a>(</span><span class="m-doc-wrap">arg0: int<span class="m-text m-dim">, /</span>) -&gt; None</span>
+            </dt>
+            <dd>A summary</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>