-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[api-docs] More documentation #2577
Conversation
/// <returns>TBD</returns> | ||
public Inlet<T1> In(int n) | ||
{ | ||
if (n <= 0) throw new ArgumentException("n must be > 0", "n"); | ||
if (n <= 0) throw new ArgumentOutOfRangeException(nameof(n), "n must be > 0"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is a big breaking change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, revert that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll revert those, but
- No one catches/processes Argument* type exceptions.
- None of our tests fail because of the change.
- It's the correct exception to throw.
This PR fleshes out more of the documentation labeled as TBD.
@@ -791,6 +799,42 @@ public ProtocolStateActor(HandshakeInfo handshakeInfo, AssociationHandle wrapped | |||
/// <param name="codec">TBD</param> | |||
/// <param name="failureDetector">TBD</param> | |||
/// <param name="refuseUid">TBD</param> | |||
/// <exception cref="AkkaProtocolException"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dang @sean-gilliam, this is awesome!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
glad you like it. it was a pita keeping track of it all :)
This PR fleshes out more of the documentation labeled as TBD.