Skip to content
This repository has been archived by the owner on Oct 28, 2021. It is now read-only.

Update needed for docs? #147

Open
odoe opened this issue Sep 18, 2014 · 2 comments
Open

Update needed for docs? #147

odoe opened this issue Sep 18, 2014 · 2 comments

Comments

@odoe
Copy link

odoe commented Sep 18, 2014

Not sure what else it may impact, but for example, the documentation for Collapse says

query('#myCollapsible').on('hidden', function () {
  // do something…
})

But I had to look at the tests to see it should actually be

query('#myCollapsible').on('hidden.bs.collapse', function () {
  // do something…
})

It looks like all the Collapse events are *.bs.collapse. Does this go for all events in other modules as well?

@xsokev
Copy link
Owner

xsokev commented Sep 18, 2014

Looks like the docs should definitely be updated. In the latest release,
events were changed to match Bootstrap but the docs weren't updated
appropriately. I'm sure other modules will need to be updated as well.

Thanks for pointing that out Rene.

On Thu, Sep 18, 2014 at 1:55 PM, Rene Rubalcava notifications@github.com
wrote:

Not sure what else it may impact, but for example, the documentation for
Collapse http://xsokev.github.io/Dojo-Bootstrap/collapse.html says

query('#myCollapsible').on('hidden', function () {
// do something…})

But I had to look at the tests
https://github.com/xsokev/Dojo-Bootstrap/blob/master/tests/test_Collapse.html
to see it should actually be

query('#myCollapsible').on('hidden.bs.collapse', function () {
// do something…})

It looks like all the Collapse events are *.bs.collapse. Does this go for
all events in other modules as well?


Reply to this email directly or view it on GitHub
#147.

kevin armstrong
kevin@kevinandre.com

@tomwayson
Copy link
Collaborator

Yes, the docs need to be updated.

Also, I can't say I caught all the places where the event names need to be updated to the new [event].bs.[module] syntax. I was using the process of porting the BS tests to double check that I had caught all the modules. So for any of the modules whose unit tests have not yet been converted, there might still be places where the old event name is in use.

Sadly, there's still quite a few of those :(

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

No branches or pull requests

3 participants