fix num_rhs documentation

ginkgo-project · Nov 5, 2022 · b613bc0 · b613bc0
1 parent 3cbae24
commit b613bc0
Showing 1 changed file with 4 additions and 10 deletions.
diff --git a/include/ginkgo/core/solver/triangular.hpp b/include/ginkgo/core/solver/triangular.hpp
@@ -111,11 +111,8 @@ class LowerTrs : public EnableLinOp<LowerTrs<ValueType, IndexType>>,
         /**
          * Number of right hand sides.
          *
-         * @note This value is currently a dummy value which is not used by the
-         *       analysis step. It is possible that future algorithms (cusparse
-         *       csrsm2) make use of the number of right hand sides for a more
-         *       sophisticated implementation. Hence this parameter is left
-         *       here. But currently, there is no need to use it.
+         * @note This value is currently only required for the CUDA
+         *       trisolve_algorithm::sparselib algorithm.
          */
         gko::size_type GKO_FACTORY_PARAMETER_SCALAR(num_rhs, 1u);
 
@@ -264,11 +261,8 @@ class UpperTrs : public EnableLinOp<UpperTrs<ValueType, IndexType>>,
         /**
          * Number of right hand sides.
          *
-         * @note This value is currently a dummy value which is not used by the
-         *       analysis step. It is possible that future algorithms (cusparse
-         *       csrsm2) make use of the number of right hand sides for a more
-         *       sophisticated implementation. Hence this parameter is left
-         *       here. But currently, there is no need to use it.
+         * @note This value is currently only required for the CUDA
+         *       trisolve_algorithm::sparselib algorithm.
          */
         gko::size_type GKO_FACTORY_PARAMETER_SCALAR(num_rhs, 1u);