Skip to content

Escape * in generated function signatures for Sphinx #6144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alisonpetersonhq wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −1
Open

Escape * in generated function signatures for Sphinx #6144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion include/pybind11/pybind11.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,6 +855,14 @@ class cpp_function : public function {

std::string signatures;
int index = 0;
auto append_doc_signature = [&signatures](const char *sig) {
for (const char *p = sig; *p != '\0'; ++p) {
if (*p == '*') {
signatures += '\\';
}
signatures += *p;
}
};
/* Create a nice pydoc rec including all signatures and
docstrings of the functions in the overload chain */
if (chain && options::show_function_signatures()
Expand All @@ -876,7 +884,7 @@ class cpp_function : public function {
signatures += std::to_string(++index) + ". ";
}
signatures += rec->name;
signatures += it->signature;
append_doc_signature(it->signature);
signatures += '\n';
}
if (it->doc && it->doc[0] != '\0' && options::show_user_defined_docstrings()) {
Expand Down