Open DiedrikDM opened 6 years ago
As an example fromEvent would become:
static fromEvent(target, eventName, options, selector): Observable
Thanks for this proposal @DiedrikDM . You got definetly some points. I totally agree about the access modifier with you. But I think that the parameter list should be well described due to the wide range of possibilities. But I think a link to the type would be helpful too.
I agree with @JWO719. For a beginner, it can be difficult to determine exactly what the method is looking for.
Hi everybody,
I have a couple of thoughts on trying to improve the Method Signature and I would like to get some extra feedback/thoughts from others.
public access modifier
In our new documentation every method currently starts with the public access modifier. In my opinion this is not really that helpful. All of the methods in the documentation are - as far as I know - public. So why not remove public from the signature?
parameter types
In the documentation we're adding the type of every parameter in the method signature. In my opinion this does not really help that much. Especially because the types of most parameters are either simple to deduce based on the name of the parameter or are complex types where additional research would still be necessary. Adding to that is the fact that we're adding every parameter and its type to a table where people can look up further explanation on the parameter. Here is an example:
fromEvent(target: EventTargetLike, eventName: string, options: EventListenerOptions, selector: SelectorMethodSignature): Observable
As per #168 I'm fine with deducing the type of every parameter based on further documentation, but maybe we could add that information when hovering over a parameter in the signature?
Other people's thoughts?