Started creating scripting library/namespace and added sol2 for interfacing

1 files changed, 9 insertions, 0 deletions

diff --git a/lib/sol2/docs/source/api/optional.rst b/lib/sol2/docs/source/api/optional.rst
new file mode 100644
index 0000000..50fffda
--- /dev/null
+++ b/lib/sol2/docs/source/api/optional.rst
@@ -0,0 +1,9 @@
+optional<T>
+===========
+
+This is an implemention of `optional from the standard library`_. If it detects that a proper optional exists, it will attempt to use it. This is mostly an implementation detail, used in the :ref:`sol::stack::check_get<stack-check-get>` and :ref:`sol::stack::get\<optional\<T>><stack-get>` and ``sol::optional<T> maybe_value = table["arf"];`` implementations for additional safety reasons.
+
+See `this example here`_ for a demonstration on how to use it and other features!
+
+.. _optional from the standard library: http://en.cppreference.com/w/cpp/utility/optional
+.. _this example here: https://github.com/ThePhD/sol2/blob/develop/examples/source/optional_with_iteration.cpp