search

VinceG / twitter-bootstrap-wizard

This twitter bootstrap plugin builds a wizard out of a formatter tabbable structure. It allows to build a wizard functionality using buttons to go through the different wizard steps and using events allows to hook into each step individually.
MIT License
1.39k stars 676 forks source link

Event method documentation - please provide possible function arguments... #79

Closed dkimbell13 closed 10 years ago

dkimbell13 commented 10 years ago

Probably not a priority - but what are the arguments provided to each Event Type function?

I had to look through the code for the following definitions... Which is fine, but it sure would be nice to have this in the documentation up front....

e.g. onShow($activeTab, $navigation, obj.nextIndex()) e.g. onPrevious($activeTab, $navigation, obj.previousIndex()) e.g. onTabChange($activeTab, $navigation, obj.currentIndex(), nextTab)

VinceG commented 10 years ago

it's not that hard to view the code and figure it out. there are only a handful of events.

dkimbell13 commented 10 years ago

That is true. No question about it... But good documentation is part of a good plugin. I'll fork it and try to do some documentation myself, if I can find some time... Good documentation saves time too! Sorry to preach... On May 12, 2014 5:57 PM, "Vincent Gabriel" notifications@github.com wrote:

it's not that hard to view the code and figure it out. there are only a handful of events.

— Reply to this email directly or view it on GitHubhttps://github.com/VinceG/twitter-bootstrap-wizard/issues/79#issuecomment-42909648 .

grimurd commented 9 years ago

I must agree with this. Not everyone can understand it by reading the code and it's not like its a lot of work to document the arguments for each event.