Sugar icon indicating copy to clipboard operation
Sugar copied to clipboard

Add option to show native methods in docs

Open dlee opened this issue 11 years ago • 9 comments

It would be super useful to show native methods in the docs, so that there's one place to see all methods available on a given type.

dlee avatar Jul 29 '12 00:07 dlee

Like.... all of them?

String#toUpperCase... all?

andrewplummer avatar Jul 29 '12 02:07 andrewplummer

@andrewplummer Yup. I'm thinking it would about double the number of methods in the docs.

dlee avatar Jul 29 '12 06:07 dlee

Yeah, so I'm thinking that's more what this area was designed for:

http://sugarjs.com/libs

andrewplummer avatar Jul 29 '12 08:07 andrewplummer

I'm not exactly exactly what you have in mind, but I don't think that would serve as the ultimate Sugarified Javascript reference doc.

I'm not trying to find "how do I do this thing that I know how to do in another language?" (that seems to be the purpose of the page you linked to). I'm trying to see what methods are available on a certain Javascript type, irrespective of whether the method's native or sugar-implanted.

dlee avatar Jul 29 '12 08:07 dlee

Right well of course it doesn't fit into any of the packages presented, but it would be its own thing, like a native JS reference. Of course I like the idea of "the ultimate" JS reference, but I don't really think it belongs within the documentation for Sugar itself.

andrewplummer avatar Jul 29 '12 09:07 andrewplummer

Cool, as long as you have "the ultimate" JS reference somewhere, I'm fine with that. That's why I said "option to show native methods", since I agree that we don't want to clutter the documentation for Sugar itself by default.

dlee avatar Jul 29 '12 09:07 dlee

This is it. The comment that I've taken the longest to get around to. And guess what, I'm still going to leave it open. Both the library and the documentation have received major updates, and there's now a nice "options" for the docs where this could fit in. It's taken ages and I'm still kind of on the fence about it... I mean, do people really want docs for String.prototype.blink??? In any case, I still kind of like this idea and it will be the last thing to make my world complete, so I still want to give it fair consideration, but it will take a bit more time (ha-ha right?)

andrewplummer avatar Dec 04 '16 15:12 andrewplummer

Ooops my hand is now reaching for the close button instinctively at this point. Itching to do it for this one too....

andrewplummer avatar Dec 04 '16 15:12 andrewplummer

I'd vote to close this and add maybe links to MDN. This seems like a big effort to keep up with.

EvanHahn avatar Oct 25 '17 21:10 EvanHahn