Doc clarifications

ginkgo-project · Oct 11, 2023 · b5ff8ca · b5ff8ca
1 parent 175db29
commit b5ff8ca
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/include/ginkgo/core/base/batch_lin_op.hpp b/include/ginkgo/core/base/batch_lin_op.hpp
@@ -73,14 +73,15 @@ namespace batch {
  *
  * A key difference between the LinOp and the BatchLinOp class is that the apply
  * between BatchLinOps is no longer supported. The user can apply a BatchLinOp
- * to a batch::MultiVector but not to any general BatchLinOp. This apply to a
- * batch::MultiVector is handled by the concrete LinOp and may be moved to the
- * base BatchLinOp class in the future.
+ * to a batch::MultiVector but not to any general BatchLinOp.
  *
  * Therefore, the BatchLinOp serves only as a base class providing necessary
  * core functionality from Polymorphic object and store the dimensions of the
  * batched object.
  *
+ * @note Apply to batch::MultiVector objects are handled by the concrete LinOp
+ * and may be moved to the base BatchLinOp class in the future.
+ *
  * @ref BatchLinOp
  */
 class BatchLinOp : public EnableAbstractPolymorphicObject<BatchLinOp> {