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

#yourfirstpr - Update our template and remove thousands of warnings from our build logs. #1005

Closed
ghuntley opened this Issue Dec 25, 2015 · 3 comments

Comments

Projects
None yet
3 participants
@ghuntley
Copy link
Member

ghuntley commented Dec 25, 2015

Instead of fixing this issue immediately, we are leaving this issue open and up for grabs for someone who has never contributed to open source before. We will not accept solutions to this issue from non-first-timers to this project or open-source, we will check.

Problem

We lack XML documentation on our ReactiveUI-Events package which results in an excessive amount of warnings when building ReactiveUI on our continuous integration environment.

It really doesn't make sense to go back and add the missing XML documentation as these projects are automatically generated by a moustache template and a console application.

Additionally it does not make sense to add dummy XML documentation so the approach we are proposing is update the template that generates the projects to supress the compiler warning.

Suggested Resolution

On https://github.com/reactiveui/ReactiveUI/blob/master/ReactiveUI.Events/Events.mustache#L14

At the top of the file you will find the following section

{{#Namespaces}}
namespace {{Name}}

Change it to be

#pragma warning disable 1591
{{#Namespaces}}
namespace {{Name}}

At the bottom of the file you will find the following section

{{/Types}}
}
{{/DelegateNamespaces}}

Change it to be

{{/Types}}
}
#pragma warning restore 1591
{{/DelegateNamespaces}}

Submit your first pull-request and when it gets merged, we will send a tweet to @yourfirstpr in celebration :)

What you'll be fixing

In our build logs #1006 we have thousands of these annoying and erroneous warning messages:

Events.cs(2506,16): warning CS1591: Missing XML comment for publicly visible type or member 'TimelineEvents.TimelineEvents(Timeline)' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2512,46): warning CS1591: Missing XML comment for publicly visible type or member 'TimelineEvents.CurrentStateInvalidated' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2516,46): warning CS1591: Missing XML comment for publicly visible type or member 'TimelineEvents.CurrentTimeInvalidated' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2520,46): warning CS1591: Missing XML comment for publicly visible type or member 'TimelineEvents.CurrentGlobalSpeedInvalidated' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2524,46): warning CS1591: Missing XML comment for publicly visible type or member 'TimelineEvents.Completed' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2528,46): warning CS1591: Missing XML comment for publicly visible type or member 'TimelineEvents.RemoveRequested' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2536,25): warning CS1591: Missing XML comment for publicly visible type or member 'EventsMixin' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2538,43): warning CS1591: Missing XML comment for publicly visible type or member 'EventsMixin.Events(BitmapDecoder)' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2542,42): warning CS1591: Missing XML comment for publicly visible type or member 'EventsMixin.Events(BitmapSource)' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2548,18): warning CS1591: Missing XML comment for publicly visible type or member 'BitmapDecoderEvents' [C:\projects\reactiveui\ReactiveUI.Events\ReactiveUI.Events_Net45.csproj]
Events.cs(2552,16): warning CS1591: Missing XML comment for publicly visible type or member 'BitmapDecoderEvents.BitmapDecoderEvents(BitmapDecoder)' 
@varjmes

This comment has been minimized.

Copy link

varjmes commented Dec 28, 2015

Thanks for this great issue! Putting it up on the @yourfirstpr account tomorrow at 1pm (GMT).

@ghuntley

This comment has been minimized.

Copy link
Member Author

ghuntley commented Dec 30, 2015

@Charlotteis this PR has been resolved by @Avrozavr!

See #1010

This has been a pleasure, look forward to working with you again in the future.

@ghuntley ghuntley closed this Dec 30, 2015

@varjmes

This comment has been minimized.

Copy link

varjmes commented Dec 30, 2015

Nicely done :)

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