You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reecent F# compilers warn on missing param names in XML Documentation, so generated xmldocs should be exhaustive here to prevent confusion.
Here's a sample from generated vscode APIs:
moduleAuthentication =type[<AllowNullLiteral>]IExports=/// <summary>Register an authentication provider./// /// There can only be one provider per id and an error is being thrown when an id/// has already been used by another provider. Ids are case-sensitive.</summary>/// <param name="id">The unique identifier of the provider.</param>/// <param name="label">The human-readable name of the provider.</param>/// <param name="provider">The authentication provider provider.</param>abstractregisterAuthenticationProvider: id:string* label:string* provider:AuthenticationProvider*?options:AuthenticationProviderOptions->Disposable
note the missing options parameter here, which causes FS3390 to be fired.
The text was updated successfully, but these errors were encountered:
Note:
Since #414 ts2fable emits a #nowarn "3390" when there are xml comments (-> disable warnings about XML comments). That was easier than fixing all xml doc issues.
(Additional to invalid or missing params, quite often transformed links (<see cref=... in F#) turn out to be invalid (point to something TypesScripty or to something external. Also there a ton of different styles for links in JS with some resulting in incorrect translations))
Reecent F# compilers warn on missing param names in XML Documentation, so generated xmldocs should be exhaustive here to prevent confusion.
Here's a sample from generated vscode APIs:
note the missing
options
parameter here, which causes FS3390 to be fired.The text was updated successfully, but these errors were encountered: