Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to show native methods in docs #172

Open
dlee opened this issue Jul 29, 2012 · 9 comments
Open

Add option to show native methods in docs #172

dlee opened this issue Jul 29, 2012 · 9 comments
Labels

Comments

@dlee
Copy link

dlee commented Jul 29, 2012

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.

@andrewplummer
Copy link
Owner

Like.... all of them?

String#toUpperCase... all?

@dlee
Copy link
Author

dlee commented Jul 29, 2012

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

@andrewplummer
Copy link
Owner

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

http://sugarjs.com/libs

@dlee
Copy link
Author

dlee commented Jul 29, 2012

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.

@andrewplummer
Copy link
Owner

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.

@dlee
Copy link
Author

dlee commented Jul 29, 2012

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.

@andrewplummer
Copy link
Owner

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
Copy link
Owner

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

@andrewplummer andrewplummer reopened this Dec 4, 2016
@EvanHahn
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants