Skip to content
This repository has been archived by the owner on Mar 25, 2018. It is now read-only.

Suggestion: Return type in function declaration & possible option to view types by clicking #129

Closed
luki opened this issue Aug 4, 2017 · 2 comments

Comments

@luki
Copy link

luki commented Aug 4, 2017

While working with Node.js, I found having the return types of a function (If given) in the function declaration instead of somewhere in the paragraph below it (As seen in the example following) might improve the documentation.

Example screenshot

Further on, it would most likely be useful to be able to click on the types. Both suggestions are popular documentation features, example is the Rust Documentation

Here a screenshot of what I mean
Example screenshot

@vsemozhetbyt
Copy link

сс @nodejs/documentation

@gibfahn
Copy link
Member

gibfahn commented Aug 5, 2017

This is a duplicate of nodejs/node#14624 right? If so I'll close, as it looks like that issue has more discussion.

LMK if this should be reopened!

@gibfahn gibfahn closed this as completed Aug 5, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants