Fix sample code for Timeout overload
#1109
Conversation
The overload takes a `Func<TimeSpan>`, and it is assumed that we already have a lambda variable called `myTimeoutProvider, but the variable is incorrectly passed to the overload.
| @@ -619,7 +619,7 @@ Policy | |||
|
|
|||
| // Configure variable timeout via a func provider. | |||
| Policy | |||
| .Timeout(() => myTimeoutProvider)) // Func<TimeSpan> myTimeoutProvider | |||
| .Timeout(myTimeoutProvider)) // Func<TimeSpan> myTimeoutProvider | |||
There was a problem hiding this comment.
Alternatively, it could also be this:
| .Timeout(myTimeoutProvider)) // Func<TimeSpan> myTimeoutProvider | |
| .Timeout(() => myTimeoutProvider())) // Func<TimeSpan> myTimeoutProvider |
There was a problem hiding this comment.
Yes, but why someone would need to do this? 😊
There was a problem hiding this comment.
IMHO it makes the intent clearer to the reader outside of an IDE (i.e. in our documentation) that it's a delegate and not simple variable.
There was a problem hiding this comment.
I also thought of that, but that's why there is a comment in front of the code. It is not always possible (or good) to make everything super easy. The reader already took the time to read the README file to that point and already looked at samples. At this point, there are four different hints for the reader: 1- This sample should have something new compared to the two samples above it, 2- The comment above the code says "via a func provider", 3- the variable name ends with Provider, 4- The comment in front states the variable type.
No one can help someone that just wants to copy a code snippet that he/she found, blindly, without paying attention.
Sorry for the long comment 😋. I hope I was able to deliver my point.
There was a problem hiding this comment.
And the library is already complicated enough, that not paying attention will not help the reader.
The overload takes a
Func<TimeSpan>, and it is assumed that we already have a lambda variable called `myTimeoutProvider, but the variable is incorrectly passed to the overload.Confirm the following