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
/// <summary>/// Dispose all given items when the parent <c>SutilElement</c> is unmounted. Each item should implement <c>System.IDisposable</c>.////// See also: <seealso cref="M:Sutil.DOM.unsubscribeOnUnmount"/>/// </summary>
I'm not providing the full signature for unsubscribeOnUmount, because:
Currently fsdocs makes an effort to find something to link to, but stops at the containing enitty (in this case Sutil.DOM).
I've written a small amount of code that tries a little bit harder and goes on to find the actual member being specified. It stops at the first match, so overloads are an issue. Still, I think this adds value to the experience of writing docs.
I will send a PR.
The text was updated successfully, but these errors were encountered:
Another approach here would be to make the F# compiler always embed the fully qualified form, but let users write the simpler forms in the XMLDoc. This is what C# does and it feels very nice. Devs only have to worry about using the 'normal' names of things, and the compiler generates and uses the doc signature strings behind the scenes.
davedawkins
added a commit
to davedawkins/FSharp.Formatting
that referenced
this issue
Jan 15, 2023
In this example
I'm not providing the full signature for unsubscribeOnUmount, because:
Actual signature
It's all noise and friction.
Currently fsdocs makes an effort to find something to link to, but stops at the containing enitty (in this case
Sutil.DOM
).I've written a small amount of code that tries a little bit harder and goes on to find the actual member being specified. It stops at the first match, so overloads are an issue. Still, I think this adds value to the experience of writing docs.
I will send a PR.
The text was updated successfully, but these errors were encountered: