[#1130] Add documentation for the exposed Popcorn.options #25

Merged
merged 2 commits into from Jul 19, 2012

Conversation

Projects
None yet
3 participants
@dseif

View changes

popcorn-constructor/_posts/2012-12-12-popcornoptions.md
+
+## Purpose ##
+
+Provides access to all of the options that were passed in with the optionsObject upon creation of the Popcorn instance.

This comment has been minimized.

Show comment Hide comment
@dseif

dseif Jul 19, 2012

Member

optionsObject should link to what it's talking about

@dseif

dseif Jul 19, 2012

Member

optionsObject should link to what it's talking about

This comment has been minimized.

Show comment Hide comment
@rwaldron

rwaldron Jul 19, 2012

Contributor
@dseif

View changes

popcorn-constructor/_posts/2012-12-12-popcornoptions.md
+Provides access to all of the options that were passed in with the optionsObject upon creation of the Popcorn instance.
+## Example ##
+
+[Live video showing how to console.log the options values ](http://jsfiddle.net/popcornjs/uSpJH/)

This comment has been minimized.

Show comment Hide comment
@dseif

dseif Jul 19, 2012

Member

What about defaults?

@dseif

dseif Jul 19, 2012

Member

What about defaults?

This comment has been minimized.

Show comment Hide comment
@rwaldron

rwaldron Jul 19, 2012

Contributor

I'm not sure this makes sense... Popcorn.options looks like a "static" property on the Popcorn constructor object

@rwaldron

rwaldron Jul 19, 2012

Contributor

I'm not sure this makes sense... Popcorn.options looks like a "static" property on the Popcorn constructor object

This comment has been minimized.

Show comment Hide comment
@dseif

dseif Jul 19, 2012

Member

yea I forgot you can just do instance.defults( "pluginName", { /* defaults */ }); looks good to me!

@dseif

dseif Jul 19, 2012

Member

yea I forgot you can just do instance.defults( "pluginName", { /* defaults */ }); looks good to me!

dseif added a commit that referenced this pull request Jul 19, 2012

Merge pull request #25 from mjschranz/t1130
[#1130] Add documentation for the exposed Popcorn.options

@dseif dseif merged commit a0cacae into mozilla:gh-pages Jul 19, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment