style: tidy up and expand comments in Activation #1268
Conversation
| @@ -54,6 +54,9 @@ public sealed class ViewModelActivator | |||
| /// <value>The deactivated.</value> | |||
| public IObservable<Unit> Deactivated { get { return deactivated; } } | |||
|
|
|||
| /// <summary> | |||
There was a problem hiding this comment.
Comments like this always feel...pointless, happy to remove it if wanted but thought since I'm here I may as well fix the compile time warning...
There was a problem hiding this comment.
Voted pointless, the return type is Unit
See above for another line that can be 🔥
There was a problem hiding this comment.
In terms of compiler warnings (can't remember exactly what you get for missing a returns...), would you prefer empty comments or nothing at all?
| @@ -315,16 +343,29 @@ static IDisposable handleViewModelActivation(IViewFor view, IObservable<bool> ac | |||
|
|
|||
| /// <summary> | |||
| /// This class implements View Activation for classes that explicitly describe | |||
| /// their activation via ICanActivate. This class is used by the framework. | |||
| /// their activation via <see cref="ICanActivate"/>. This class is used by the framework. | |||
| /// </summary> | |||
| public class CanActivateViewFetcher : IActivationForViewFetcher | |||
There was a problem hiding this comment.
This feels like it should be in internal class, it's whole purpose in life is to be something used by the framework rather than end consumers, but that's definitely a breaking change/needs some discussion...
There was a problem hiding this comment.
Hmm, I don't know.
My perspective on breaking stuff has changed since starting work on video courseware; there has to be an incredibly good reason to do it as it wastes the time of consumers and my time if the courseware needs to be updated. @kentcb probably has similar feelings as he's going through this process right now with authoring a book.
I had a quick look at the GitHub for Desktop aka Visual Studio plugin source code and it has taken no references to this class. It's one of the larger open-source projects that uses ReactiveUI. https://github.com/github/VisualStudio/search?utf8=%E2%9C%93&q=CanActivateViewFetcher
There was a problem hiding this comment.
I'm wary of breaking things, but the pre-existing comment is along the lines of "used by the framework" and it's explicitly registered by ReactiveUI, so think its both fairly low risk and fairly low impact....
|
Thanks @olevett! |
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
More comment tidying, in Activation this time
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: