Add simple doc strings to pybind11 interface

lsst · Feb 2, 2022 · 0888f70 · 0888f70
1 parent ac2ed88
commit 0888f70
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/python/lsst/base/threads.cc b/python/lsst/base/threads.cc
@@ -30,11 +30,12 @@ namespace lsst {
 namespace base {
 
 PYBIND11_MODULE(threads, mod) {
-    mod.def("haveThreads", &lsst::base::haveThreads);
-    mod.def("setNumThreads", &lsst::base::setNumThreads);
-    mod.def("getNumThreads", &lsst::base::getNumThreads);
-    mod.def("disableImplicitThreading", &lsst::base::disableImplicitThreading);
+    mod.def("haveThreads", &lsst::base::haveThreads, "Are threaded packages available?");
+    mod.def("setNumThreads", &lsst::base::setNumThreads, "Set number of threads to use.");
+    mod.def("getNumThreads", &lsst::base::getNumThreads, "Get maximum number of threads we might use.");
+    mod.def("disableImplicitThreading", &lsst::base::disableImplicitThreading,
+            "Disable threading that has not been set explicitly.");
 }
 
 }  // lsst
-}  // base
+}  // base