Update docstring

BlueBrain · Oct 10, 2024 · 1348ab9 · 1348ab9
1 parent 9f6b751
commit 1348ab9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/pybind/wrapper.cpp b/src/pybind/wrapper.cpp
@@ -186,8 +186,6 @@ except Exception as e:
     return {std::move(solution), std::move(exception_message)};
 }
 
-/// \brief A blunt instrument that differentiates expression w.r.t. variable
-/// \return The tuple (solution, exception)
 std::tuple<std::string, std::string> call_diff2c(
     const std::string& expression,
     const std::string& variable,

diff --git a/src/pybind/wrapper.hpp b/src/pybind/wrapper.hpp
@@ -45,6 +45,12 @@ std::tuple<std::string, std::string> call_analytic_diff(
     const std::vector<std::string>& expressions,
     const std::set<std::string>& used_names_in_block);
 
+
+/// \brief Differentiates an expression with respect to a variable
+/// \param expression The expression we want to differentiate
+/// \param variable   The name of the independent variable we are differentiating against
+/// \param index_vars A map of array (indexable) variables (and their associated indices) that
+/// appear in \ref expression \return The tuple (solution, exception)
 std::tuple<std::string, std::string> call_diff2c(
     const std::string& expression,
     const std::string& variable,