mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-25 14:45:12 +00:00
Merge pull request #119 from SylvainCorlay/docstring
Signature formatting for sphinx
This commit is contained in:
commit
eb5277b38e
@ -1,22 +1,22 @@
|
||||
Help on built-in function kw_func in module example
|
||||
|
||||
kkww__ffuunncc(...)
|
||||
Signature : (x : int, y : int) -> NoneType
|
||||
kw_func(x : int, y : int) -> NoneType
|
||||
|
||||
Help on built-in function kw_func2 in module example
|
||||
|
||||
kkww__ffuunncc22(...)
|
||||
Signature : (x : int = 100L, y : int = 200L) -> NoneType
|
||||
kw_func2(x : int = 100L, y : int = 200L) -> NoneType
|
||||
|
||||
Help on built-in function kw_func3 in module example
|
||||
|
||||
kkww__ffuunncc33(...)
|
||||
Signature : (data : unicode = u'Hello world!') -> NoneType
|
||||
kw_func3(data : unicode = u'Hello world!') -> NoneType
|
||||
|
||||
Help on built-in function kw_func4 in module example
|
||||
|
||||
kkww__ffuunncc44(...)
|
||||
Signature : (myList : list<int> = [13L, 17L]) -> NoneType
|
||||
kw_func4(myList : list<int> = [13L, 17L]) -> NoneType
|
||||
|
||||
kw_func(x=5, y=10)
|
||||
kw_func(x=5, y=10)
|
||||
|
@ -295,10 +295,17 @@ protected:
|
||||
int index = 0;
|
||||
/* Create a nice pydoc rec including all signatures and
|
||||
docstrings of the functions in the overload chain */
|
||||
if (chain) {
|
||||
// First a generic signature
|
||||
signatures += rec->name;
|
||||
signatures += "(*args, **kwargs)\n";
|
||||
signatures += "Overloaded function.\n\n";
|
||||
}
|
||||
// Then specific overload signatures
|
||||
for (auto it = chain_start; it != nullptr; it = it->next) {
|
||||
if (chain)
|
||||
signatures += std::to_string(++index) + ". ";
|
||||
signatures += "Signature : ";
|
||||
signatures += rec->name;
|
||||
signatures += it->signature;
|
||||
signatures += "\n";
|
||||
if (it->doc && strlen(it->doc) > 0) {
|
||||
|
Loading…
Reference in New Issue
Block a user