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

Projects
None yet
4 participants
@olevett
Copy link
Member

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

This comment has been minimized.

Copy link

coveralls commented Feb 8, 2017

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>

This comment has been minimized.

@kentcb

kentcb Feb 8, 2017

Contributor

lolwat - good catch!

@kentcb

kentcb approved these changes Feb 8, 2017

Copy link
Contributor

kentcb left a comment

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()

This comment has been minimized.

@kentcb

kentcb Feb 8, 2017

Contributor

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

This comment has been minimized.

@olevett

olevett Feb 8, 2017

Author Member

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...

This comment has been minimized.

@ghuntley

ghuntley Feb 8, 2017

Member

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()

This comment has been minimized.

@ghuntley

ghuntley Feb 8, 2017

Member

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

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
coverage/coveralls Coverage remained the same at 65.874%
Details

@olevett olevett deleted the olevett:tidying-comments branch Feb 9, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment