Fix some typos in the README. #91
Conversation
carwynmoore
commented
Jul 15, 2016
carwynmoore
commented
- Renamed MaxInFlight to MaxInflight (lowercase f) to match code.
- Adding missing double quote
| @@ -167,10 +167,10 @@ This mismatch is commonly called a "fast producer/slow consumer" problem, and ma | |||
|
|
|||
| ### Publisher rate limiting | |||
|
|
|||
| NATS Streaming provides a connection option called `MaxPubAcksInFlight` that effectively limits the number of unacknowledged messages that a publisher may have in-flight at any given time. When this maximum is reached, further `PublishAsync()` calls will block until the number of unacknowledged messages falls below the specified limit. ex: | |||
| NATS Streaming provides a connection option called `MaxPubAcksInflight` that effectively limits the number of unacknowledged messages that a publisher may have in-flight at any given time. When this maximum is reached, further `PublishAsync()` calls will block until the number of unacknowledged messages falls below the specified limit. ex: | |||
There was a problem hiding this comment.
The property MaxPubAcksInflight is really incorrectly named. It really should be MaxPubAcksInFlight. It always stumps me. Likely the time to make the change is now or never.
@kozlovic @ColinSullivan1
There was a problem hiding this comment.
Perhaps add the new one and deprecate the API. I hate to make breaking changes past alpha/beta.
There was a problem hiding this comment.
So now my question is what about PR #88, where we provide an option setter that I have named MaxPubAcksInFlight, should it stay this way? If users use the new option setter to set that option, it will be less of an issue if it is not named properly (since they won't directly reference the option itself). Comments?
There was a problem hiding this comment.
Keep theMaxPubsAckInFlight option, the code at least will look correct. However with other language client implementations we need to be careful, or we need to normalize. We can take this offline.
|
LGTM - Thank you @carwynmoore for the contribution! |
