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

style: tidy up comments for ReactiveBinding and command binding #1267

Merged
merged 2 commits into from
Feb 8, 2017

Conversation

olevett
Copy link
Member

@olevett olevett commented Feb 8, 2017

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Tidying comments in a couple of binding related files.

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change?

Please check if the PR fulfills these requirements

Other information:

@coveralls
Copy link

Coverage Status

Coverage remained the same at 65.874% when pulling 8d12b0e on olevett:tidying-comments into 51249d4 on reactiveui:develop.

@@ -18,7 +18,7 @@ public interface IReactiveBinding<TView, TViewModel, TValue> : IDisposable
where TView : IViewFor
{
/// <summary>
/// The instance of the view model this binding is applied to.</param>
Copy link
Contributor

Choose a reason for hiding this comment

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

lolwat - good catch!

Copy link
Contributor

@kentcb kentcb left a comment

Choose a reason for hiding this comment

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

Noice!

@@ -150,9 +141,6 @@ internal class ReactiveBinding<TView, TViewModel, TValue> : IReactiveBinding<TVi
/// </value>
public BindingDirection Direction { get; private set; }

/// <summary>
/// Releases unmanaged and - optionally - managed resources.
/// </summary>
public void Dispose()
Copy link
Contributor

Choose a reason for hiding this comment

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

Wow, where did this originate from? Looks like some incredibly useful ghostdoc vomit.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't really know...it seemed a bit like stating the obvious. To be honest, I'm not sure any of these comments make sense on the internal implementation of the fairly well commented interface...

Copy link
Member

Choose a reason for hiding this comment

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

GhostDoc noise can burn in a pit of 🔥

@@ -150,9 +141,6 @@ internal class ReactiveBinding<TView, TViewModel, TValue> : IReactiveBinding<TVi
/// </value>
public BindingDirection Direction { get; private set; }

/// <summary>
/// Releases unmanaged and - optionally - managed resources.
/// </summary>
public void Dispose()
Copy link
Member

Choose a reason for hiding this comment

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

GhostDoc noise can burn in a pit of 🔥

@ghuntley ghuntley added this to the vNext milestone Feb 8, 2017
@ghuntley ghuntley changed the title Tidying comments style: tidy up comments for ReactiveBinding and command binding Feb 8, 2017
@ghuntley ghuntley merged commit 3b97bcc into reactiveui:develop Feb 8, 2017
@olevett olevett deleted the tidying-comments branch February 9, 2017 13:00
@lock lock bot locked and limited conversation to collaborators Jun 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants