Skip to content
This repository was archived by the owner on May 3, 2026. It is now read-only.

Commit 2c8464a

Browse files
committed
improve Result::or_else constraint documentation
1 parent 0e05111 commit 2c8464a

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

include/common/result.hpp

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ class Result<T, Errs...> {
135135
*
136136
* constraints:
137137
* - Callable must be invocable with all error types as arguments
138-
* - If invocable, the callable must always return the same type regardless of argument type
139-
* - If invocable, the callable must return a Result
138+
* - The callable must always return the same type regardless of argument type
139+
* - The callable must return a Result
140140
* - The Result returned by the callable must have the same value type
141141
*
142142
* @tparam Self deduced self type
@@ -146,9 +146,9 @@ class Result<T, Errs...> {
146146
*/
147147
template<typename Self, typename F>
148148
requires traits::AllInvocable<Self, F, Errs...>
149-
// the callable must always return the same type (if it's invocable)
149+
// the callable must always return the same type
150150
&& traits::AllSame<traits::or_else_return_t<Self, F, Errs>...>
151-
// the callable must return a Result (if it's invocable)
151+
// the callable must return a Result
152152
&& traits::AllResult<Self, F, Errs...>
153153
// the Result returned by the callable must have the same value type
154154
&& traits::AllValueTypeMatch<Self, traits::or_else_return_t<Self, F, Errs>...>
@@ -307,9 +307,9 @@ class Result<void, Errs...> {
307307
* expressions, as fold expressions significantly complicates error messages
308308
*
309309
* constraints:
310-
* - Callable must be invocable with any error type as an argument
311-
* - If invocable, the callable must always return the same type regardless of argument type
312-
* - If invocable, the callable must return a Result
310+
* - Callable must be invocable with all error types as arguments
311+
* - The callable must always return the same type regardless of argument type
312+
* - The callable must return a Result
313313
* - The Result returned by the callable must have the same value type
314314
*
315315
* @tparam Self deduced self type
@@ -319,9 +319,9 @@ class Result<void, Errs...> {
319319
*/
320320
template<typename Self, typename F>
321321
requires traits::AllInvocable<Self, F, Errs...>
322-
// the callable must always return the same type (if it's invocable)
322+
// the callable must always return the same type
323323
&& traits::AllSame<traits::or_else_return_t<Self, F, Errs>...>
324-
// the callable must return a Result (if it's invocable)
324+
// the callable must return a Result
325325
&& traits::AllResult<Self, F, Errs...>
326326
// the Result returned by the callable must have the same value type
327327
&& traits::AllValueTypeMatch<Self, traits::or_else_return_t<Self, F, Errs>...>

0 commit comments

Comments
 (0)