better docstring for BayesNet::error

2023-11-20 10:34:11 -05:00 · 2023-11-20 10:34:11 -05:00 · eabd11df6f
parent a2ba56de27
commit eabd11df6f
1 changed files with 4 additions and 1 deletions
--- a/gtsam/hybrid/HybridBayesNet.h
+++ b/gtsam/hybrid/HybridBayesNet.h
@ -189,7 +189,10 @@ class GTSAM_EXPORT HybridBayesNet : public BayesNet<HybridConditional> {
   */
  AlgebraicDecisionTree<Key> error(const VectorValues &continuousValues) const;

-  /// Error method using HybridValues which returns specific error.
+  /**
+   * @brief Error method using HybridValues which returns specific error for
+   * assignment.
+   */
  using Base::error;

  /**