Skip to content
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

Fixed various typos in comments and field names. Fixed Exception for passing comment correctly #286

Closed
wants to merge 5 commits into from

Conversation

CycoPH
Copy link

@CycoPH CycoPH commented Sep 23, 2019

  • Fixed various typos in comments
  • Fixed the naming of a field. ArrivalSubscription had a typo
  • Fixed bug in NATSBadSubscriptionException.
  • The passed error message was never forwarded to the NATSException container

Peter Hinz added 3 commits September 23, 2019 10:28
- The passed error message was never forwarded to the NATSException container
ArrivalSubscription had a type
Copy link
Collaborator

@watfordgnf watfordgnf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no issues with the changes at hand, just we need to consider the implications of Msg.ArrivalSubscription being renamed.

@@ -162,7 +162,7 @@ public void AssignData(byte[] data)
/// <summary>
/// Gets the <see cref="ISubscription"/> which received the message.
/// </summary>
public ISubscription ArrivalSubcription
public ISubscription ArrivalSubscription
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a breaking change to the API (but a very reasonable one). Perhaps we should consider the original misnamed property forwarding to the new property, with the original property marked as Obsolete?

@ColinSullivan1

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I agree. Wow, am I embarrassed at that one. Yep, we should keep both, and mark ArrivalSubcription obsolete. We can then remove it for version 1.0.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CycoPH, would you mind adding a new property (correcting my spelling), adding an obsolete attribute, e.g.

[ObsoleteAttribute("This property will soon be deprecated. Use ArrivalSubscription instead.")]

...and have the old property call the new one?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure did the change a resubmitted

@ColinSullivan1
Copy link
Member

LGTM, other than the comments above. Thank you for the contribution!

/// Gets the <see cref="ISubscription"/> which received the message.
/// </summary>
[ObsoleteAttribute("This property will soon be deprecated. Use ArrivalSubscription instead.")]
public ISubscription ArrivalSubcription
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be able to make this a one liner:

public ISubscription ArrivalSubcription => ArrivalSubscription;

@ColinSullivan1
Copy link
Member

@CycoPH , we've incorporated your changes in #346. There were so many changes since this this PR was created it was much easier to adopt your changes in a new one. You've been mentioned in the new PR and will be in the release notes. We really appreciate your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants