Skip to content

Commit

Permalink
Added docstrings for new ElementEquivalence* classes added in a5073ac.
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Habel <[email protected]>
  • Loading branch information
StefanHabel committed Oct 8, 2024
1 parent 2d664f0 commit 8df85a2
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions source/PyMaterialX/PyMaterialXCore/PyElement.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -272,13 +272,21 @@ void bindPyElement(py::module& mod)
.def_readwrite("path2", &mx::ElementEquivalenceResult::path2)
.def_readwrite("differenceType", &mx::ElementEquivalenceResult::differenceType)
.def_readwrite("attributeName", &mx::ElementEquivalenceResult::attributeName);
mod.attr("ElementEquivalenceResult").doc() = R"docstring(
A comparison result for the functional equivalence of two elements.
:see: https://materialx.org/docs/api/class_element_equivalence_result.html)docstring";

py::class_<mx::ElementEquivalenceOptions>(mod, "ElementEquivalenceOptions")
.def_readwrite("format", &mx::ElementEquivalenceOptions::format)
.def_readwrite("precision", &mx::ElementEquivalenceOptions::precision)
.def_readwrite("skipAttributes", &mx::ElementEquivalenceOptions::skipAttributes)
.def_readwrite("skipValueComparisons", &mx::ElementEquivalenceOptions::skipValueComparisons)
.def(py::init<>());
mod.attr("ElementEquivalenceOptions").doc() = R"docstring(
A set of options for comparing the functional equivalence of elements.
:see: https://materialx.org/docs/api/class_element_equivalence_options.html)docstring";

py::class_<mx::StringResolver, mx::StringResolverPtr>(mod, "StringResolver")
.def("setFilePrefix", &mx::StringResolver::setFilePrefix)
Expand Down

0 comments on commit 8df85a2

Please sign in to comment.