search

SplitmediaLabsLimited / xjs

XSplit JS Framework. Make plugins for XSplit Broadcaster, quickly and easily.
Other
39 stars 11 forks source link

Documentation error in API Reference for Dialog Class #172

Closed theRTC204 closed 6 years ago

theRTC204 commented 6 years ago

The return type on the show() function is incorrectly listed as Dialog when it actually returns a Promise<Dialog>. Additionally the usage example for the class incorrectly shows chaining .getResult() when it must be used inside a promise chain.

theRTC204 commented 6 years ago

Threw in a PR for this, since it's just docs updates

https://github.com/xjsframework/xjs/pull/173

virn commented 6 years ago

Hi @theRTC204 , thanks for noting those errors on the documentation. I had to make a different commit for it though, because your merge request had dialog missing before the .getResult().

theRTC204 commented 6 years ago

Hahahaha, whoops! I guess that's what I get for quickly throwing together an MR instead of actually using the code I wrote in my extension.

Thanks for taking care of this @virn!