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.

Sign up for GitHub

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
Closed

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

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bf5170a
Fixed bug in NATSBadSunscriptionException.
Sep 23, 2019
640d2c1
Fixed the naming of a field.
Sep 23, 2019
8723f34
Fixed various typos
Sep 23, 2019
695848d
Added the old ArrivalSubcription property back with an Obsolete indic…
Sep 25, 2019
dedb094
Formatting has changed to the project default
Sep 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions NATS.Client/Msg.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,19 +159,19 @@ public void AssignData(byte[] data)
this.data = data;
}

/// <summary>
/// Gets the <see cref="ISubscription"/> which received the message.
/// </summary>
[ObsoleteAttribute("This property will soon be deprecated. Use ArrivalSubscription instead.")]
public ISubscription ArrivalSubcription
{
get { return sub; }
}

/// <summary>
/// Gets the <see cref="ISubscription"/> which received the message.
/// </summary>
public ISubscription ArrivalSubscription
/// <summary>
/// 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;

{
get { return sub; }
}

/// <summary>
/// Gets the <see cref="ISubscription"/> which received the message.
/// </summary>
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

{
get { return sub; }
}
Expand Down