Bogus RS0026: Do not add multiple public overloads with optional parameters

[tmat]

The Roslyn analyzer reports bogus errors RS0026.

For example for completely sound public APIs:

public static Script<T> Create<T>(string code, ScriptOptions options = null, Type globalsType = null, InteractiveAssemblyLoader assemblyLoader = null)
public static Script<T> Create<T>(Stream code, ScriptOptions options = null, Type globalsType = null, InteractiveAssemblyLoader assemblyLoader = null)

We already have 10 suppressions of this in the code base. Seems like the analyzer should be fixed to not flag valid overloads.

[tmat]

@filipw FYI

[tmat]

@jaredpar

[mavasani]

This analyzer diagnostic was added to enforce: https://github.com/dotnet/roslyn/blob/master/docs/Adding%20Optional%20Parameters%20in%20Public%20API.md

See section DO NOT add multiple overloads with optional parameters. Also tagging @agocke @jaredpar, who have contributed to this document.

[kzu]

Another case where this analyzer is bogus IMO:

Task ExecuteAsync(IAsyncCommand command, CancellationToken cancellation = default);
Task<TResult> ExecuteAsync<TResult>(IAsyncCommand<TResult> command, CancellationToken cancellation = default);

The analyzer thinks both are overloads of each other, where one is generic and the other isn't. I wouldn't expect this case to be flagged.