More Docstrings

ax3l · Nov 30, 2023 · 227f700 · 227f700
1 parent 2d6e4a3
commit 227f700
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/src/Base/PODVector.cpp b/src/Base/PODVector.cpp
@@ -63,7 +63,7 @@ void make_PODVector(py::module &m, std::string typestr, std::string allocstr)
  .def(py::init<PODVector_type&>(), py::arg("other"))
  .def("assign", [](PODVector_type & pv, T const & value){
  pv.assign(pv.size(), value);
- }, py::arg("value"))
+ }, py::arg("value"), "assign the same value to every element")
  .def("push_back", py::overload_cast<const T&>(&PODVector_type::push_back))
  .def("pop_back", &PODVector_type::pop_back)
  .def("clear", &PODVector_type::clear)

diff --git a/src/Particle/ParticleContainer.H b/src/Particle/ParticleContainer.H
@@ -203,14 +203,16 @@ void make_ParticleContainer_and_Iterators (py::module &m, std::string allocstr)
 
  // runtime components
  .def("add_real_comp", &ParticleContainerType::template AddRealComp<bool>,
- py::arg("communicate")=true)
+ py::arg("communicate")=true, "add a new runtime component with type Real")
  .def("add_int_comp", &ParticleContainerType::template AddIntComp<bool>,
- py::arg("communicate")=true)
+ py::arg("communicate")=true, "add a new runtime component with type Int")
 
  .def("resize_runtime_real_comp", &ParticleContainerType::ResizeRuntimeRealComp,
- py::arg("new_size"), py::arg("communicate"))
+ py::arg("new_size"), py::arg("communicate"),
+ "Resize the Real runtime components (SoA)")
  .def("resize_runtime_int_comp", &ParticleContainerType::ResizeRuntimeIntComp,
- py::arg("new_size"), py::arg("communicate"))
+ py::arg("new_size"), py::arg("communicate"),
+ "Resize the Int runtime components (SoA)")
 
  .def_property_readonly("finest_level", &ParticleContainerBase::finestLevel)