aboutsummaryrefslogtreecommitdiffstats
path: root/deps/sol2/docs/source/api/tie.rst
diff options
context:
space:
mode:
authorAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:19:31 -0400
committerAndy Belle-Isle <drumsetmonkey@gmail.com>2019-08-30 00:19:31 -0400
commitbd3fe0cac583739bc0d7c4b5c8f301bb350abca0 (patch)
tree7eeb1aabcebd6999de1c3457d0882246ec0ff4d4 /deps/sol2/docs/source/api/tie.rst
parent2662ac356ce14dacfbc91689fd37244facff4989 (diff)
Renamed lib to deps so github will ignore it for language stats
Diffstat (limited to 'deps/sol2/docs/source/api/tie.rst')
-rw-r--r--deps/sol2/docs/source/api/tie.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/deps/sol2/docs/source/api/tie.rst b/deps/sol2/docs/source/api/tie.rst
new file mode 100644
index 0000000..946f7e6
--- /dev/null
+++ b/deps/sol2/docs/source/api/tie.rst
@@ -0,0 +1,11 @@
+tie
+===
+*improved version of std::tie*
+
+
+`std::tie()`_ does not work well with :doc:`sol::function<function>`'s ``sol::function_result`` returns. Use ``sol::tie`` instead. Because they're both named `tie`, you'll need to be explicit when you use sol's by naming it with the namespace (``sol::tie``), even with a ``using namespace sol;``. Here's an example:
+
+.. literalinclude:: ../../../examples/source/tie.cpp
+ :linenos:
+
+.. _std::tie(): http://en.cppreference.com/w/cpp/utility/tuple/tie