Zengtudor/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2024-11-22 05:05:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

added note about trailing commas (fixes #593)

Browse Source
This commit is contained in:
Wenzel Jakob 2017-03-22 21:39:19 +01:00
parent ed8a461d9a
commit ab26259c87
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/advanced/classes.rst
View File

@ -230,6 +230,13 @@ override the ``name()`` method):
std::string bark() override { PYBIND11_OVERLOAD(std::string, Dog, bark, ); } std::string bark() override { PYBIND11_OVERLOAD(std::string, Dog, bark, ); }
}; };
.. note::
Note the trailing commas in the ``PYBIND11_OVERLOAD`` calls to ``name()``
and ``bark()``. These are needed to portably implement a trampoline for a
function that does not take any arguments. For functions that take
a nonzero number of arguments, the trailing comma must be omitted.
A registered class derived from a pybind11-registered class with virtual A registered class derived from a pybind11-registered class with virtual
methods requires a similar trampoline class, *even if* it doesn't explicitly methods requires a similar trampoline class, *even if* it doesn't explicitly
declare or override any virtual methods itself: declare or override any virtual methods itself: