Skip to content
Snippets Groups Projects
Unverified Commit b24245a0 authored by Thorsten Hater's avatar Thorsten Hater Committed by GitHub
Browse files

Remove abuse of arg_v. (#1954)

Do not abuse `pybind::arg_v("name", T default, "description")` as `pybind::arg_v("name", "description")`.
Use descriptive names and `pybind::arg` instead.

Closes #1754 
parent 4505986d
No related branches found
No related tags found
No related merge requests found
...@@ -45,47 +45,47 @@ void write_component(const arborio::cable_cell_component& component, py::object ...@@ -45,47 +45,47 @@ void write_component(const arborio::cable_cell_component& component, py::object
void register_cable_loader(pybind11::module& m) { void register_cable_loader(pybind11::module& m) {
m.def("load_component", m.def("load_component",
&load_component, &load_component,
pybind11::arg_v("filename", "the name of the file."), pybind11::arg("filename_or_descriptor"),
"Load arbor-component (decor, morphology, label_dict, cable_cell) from file."); "Load arbor-component (decor, morphology, label_dict, cable_cell) from file.");
m.def("write_component", m.def("write_component",
[](const arborio::cable_cell_component& d, py::object fn) { [](const arborio::cable_cell_component& d, py::object fn) {
return write_component(d, fn); return write_component(d, fn);
}, },
pybind11::arg_v("object", "the cable_component object."), pybind11::arg("object"),
pybind11::arg_v("filename", "the path of the file."), pybind11::arg("filename_or_descriptor"),
"Write cable_component to file."); "Write cable_component to file.");
m.def("write_component", m.def("write_component",
[](const arb::decor& d, py::object fn) { [](const arb::decor& d, py::object fn) {
return write_component<arb::decor>(d, fn); return write_component<arb::decor>(d, fn);
}, },
pybind11::arg_v("object", "the decor object."), pybind11::arg("object"),
pybind11::arg_v("filename", "the name of the file."), pybind11::arg("filename_or_descriptor"),
"Write decor to file."); "Write decor to file.");
m.def("write_component", m.def("write_component",
[](const arb::label_dict& d, py::object fn) { [](const arb::label_dict& d, py::object fn) {
return write_component<arb::label_dict>(d, fn); return write_component<arb::label_dict>(d, fn);
}, },
pybind11::arg_v("object", "the label_dict object."), pybind11::arg("object"),
pybind11::arg_v("filename", "the name of the file."), pybind11::arg("filename_or_descriptor"),
"Write label_dict to file."); "Write label_dict to file.");
m.def("write_component", m.def("write_component",
[](const arb::morphology& d, py::object fn) { [](const arb::morphology& d, py::object fn) {
return write_component<arb::morphology>(d, fn); return write_component<arb::morphology>(d, fn);
}, },
pybind11::arg_v("object", "the morphology object."), pybind11::arg("object"),
pybind11::arg_v("filename", "the name of the file."), pybind11::arg("filename_or_descriptor"),
"Write morphology to file."); "Write morphology to file.");
m.def("write_component", m.def("write_component",
[](const arb::cable_cell& d, py::object fn) { [](const arb::cable_cell& d, py::object fn) {
return write_component<arb::cable_cell>(d, fn); return write_component<arb::cable_cell>(d, fn);
}, },
pybind11::arg_v("object", "the cable_cell object."), pybind11::arg("object"),
pybind11::arg_v("filename", "the name of the file."), pybind11::arg("filename_or_descriptor"),
"Write cable_cell to file."); "Write cable_cell to file.");
// arborio::meta_data // arborio::meta_data
......
...@@ -499,8 +499,8 @@ void register_cells(pybind11::module& m) { ...@@ -499,8 +499,8 @@ void register_cells(pybind11::module& m) {
s.scale(std::move(name), arborio::parse_iexpr_expression(ex).unwrap()); s.scale(std::move(name), arborio::parse_iexpr_expression(ex).unwrap());
return s; return s;
}, },
pybind11::arg_v("name", "name of parameter to scale."), pybind11::arg("name"),
pybind11::arg_v("ex", "iexpr for scaling"), pybind11::arg("ex"),
"Add a scaling expression to a parameter.") "Add a scaling expression to a parameter.")
.def("__repr__", .def("__repr__",
[](const arb::scaled_mechanism<arb::density>& d) { [](const arb::scaled_mechanism<arb::density>& d) {
...@@ -683,7 +683,7 @@ void register_cells(pybind11::module& m) { ...@@ -683,7 +683,7 @@ void register_cells(pybind11::module& m) {
props.default_parameters.reversal_potential_method[ion] = *m; props.default_parameters.reversal_potential_method[ion] = *m;
} }
}, },
pybind11::arg_v("ion", "name of the ion species."), pybind11::arg("ion"),
pybind11::arg_v("valence", pybind11::none(), "valence of the ion species."), pybind11::arg_v("valence", pybind11::none(), "valence of the ion species."),
pybind11::arg_v("int_con", pybind11::none(), "initial internal concentration [mM]."), pybind11::arg_v("int_con", pybind11::none(), "initial internal concentration [mM]."),
pybind11::arg_v("ext_con", pybind11::none(), "initial external concentration [mM]."), pybind11::arg_v("ext_con", pybind11::none(), "initial external concentration [mM]."),
...@@ -778,7 +778,7 @@ void register_cells(pybind11::module& m) { ...@@ -778,7 +778,7 @@ void register_cells(pybind11::module& m) {
if (auto m = maybe_method(method)) d.set_default(arb::ion_reversal_potential_method{ion, *m}); if (auto m = maybe_method(method)) d.set_default(arb::ion_reversal_potential_method{ion, *m});
return d; return d;
}, },
pybind11::arg_v("ion", "name of the ion species."), pybind11::arg("ion"),
pybind11::arg_v("int_con", pybind11::none(), "initial internal concentration [mM]."), pybind11::arg_v("int_con", pybind11::none(), "initial internal concentration [mM]."),
pybind11::arg_v("ext_con", pybind11::none(), "initial external concentration [mM]."), pybind11::arg_v("ext_con", pybind11::none(), "initial external concentration [mM]."),
pybind11::arg_v("rev_pot", pybind11::none(), "reversal potential [mV]."), pybind11::arg_v("rev_pot", pybind11::none(), "reversal potential [mV]."),
...@@ -839,7 +839,7 @@ void register_cells(pybind11::module& m) { ...@@ -839,7 +839,7 @@ void register_cells(pybind11::module& m) {
if (tempK) dec.paint(r, arb::temperature_K{*tempK}); if (tempK) dec.paint(r, arb::temperature_K{*tempK});
return dec; return dec;
}, },
pybind11::arg_v("region", "the region label or description."), pybind11::arg("region"),
pybind11::arg_v("Vm", pybind11::none(), "initial membrane voltage [mV]."), pybind11::arg_v("Vm", pybind11::none(), "initial membrane voltage [mV]."),
pybind11::arg_v("cm", pybind11::none(), "membrane capacitance [F/m²]."), pybind11::arg_v("cm", pybind11::none(), "membrane capacitance [F/m²]."),
pybind11::arg_v("rL", pybind11::none(), "axial resistivity [Ω·cm]."), pybind11::arg_v("rL", pybind11::none(), "axial resistivity [Ω·cm]."),
...@@ -897,13 +897,15 @@ void register_cells(pybind11::module& m) { ...@@ -897,13 +897,15 @@ void register_cells(pybind11::module& m) {
"The group of spike detectors has the label 'label', used for forming connections between cells.") "The group of spike detectors has the label 'label', used for forming connections between cells.")
.def("discretization", .def("discretization",
[](arb::decor& dec, const arb::cv_policy& p) { return dec.set_default(p); }, [](arb::decor& dec, const arb::cv_policy& p) { return dec.set_default(p); },
pybind11::arg_v("policy", "A cv_policy used to discretise the cell into compartments for simulation")) pybind11::arg("policy"),
"A cv_policy used to discretise the cell into compartments for simulation")
.def("discretization", .def("discretization",
[](arb::decor& dec, const std::string& p) { [](arb::decor& dec, const std::string& p) {
return dec.set_default(arborio::parse_cv_policy_expression(p).unwrap()); return dec.set_default(arborio::parse_cv_policy_expression(p).unwrap());
}, },
pybind11::arg_v("policy", "An s-expression string representing a cv_policy used to discretise the " pybind11::arg("policy"),
"cell into compartments for simulation")); "An s-expression string representing a cv_policy used to discretise the "
"cell into compartments for simulation");
// arb::cable_cell // arb::cable_cell
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment