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

General usage question #16

Closed
bwickelias opened this issue Jul 3, 2011 · 3 comments
Closed

General usage question #16

bwickelias opened this issue Jul 3, 2011 · 3 comments

Comments

@bwickelias
Copy link

I've recently found Ender JS and decided to give it a try. I like the idea but the documentation leave a lot to be desired as with this, and other modules. In the ReadMe for bean there are references to "bean.add" , "bean.remove", ".fire" and so on. But in other tickets in this repo and at ender-js forum there are conflicting references, some to .emit or even to the native method, bind. So what is the proper use of this "Module" in and out of the ender context. I mean you have to assume that when you're pushing a package deal like ender, users will expect the parts to work together. For instance when using say bean.add(element, 'click') 'element' can not be qwery('some-hml-element collection') or a collection from jQuery. But something like qwery('some-hml-element')[0] will work. This should be documented as basic usage. Why not provide a simple, working, implementation like we find for jQuery, dojo, YUI, etc.

Im not trying to bust balls. Just provide my 2 cents as a user.

B | E

@ded
Copy link
Collaborator

ded commented Jul 3, 2011

you're not the first to point this out, and it's not only Bean that suffers from this. We're still discussing a general documentation approach. But in the meantime for bean, it may be worth having a look at the Bridge file for reference sake on how it integrates into Ender

@fat
Copy link
Owner

fat commented Jul 4, 2011

Yep -- totally agree.

@fat
Copy link
Owner

fat commented Jul 13, 2011

I added some more notes on whats included in the ender bridge fil in a doc section called "Ender Integration API" -- hopefully this will grow over time and become more clear -- but this should hold you over until we figure out a better ender doc style.

thanks!

@fat fat closed this as completed Jul 13, 2011
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants