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.

Sign up for GitHub

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

Jump to bottom

Extend documentation #35

Closed
julkue opened this issue Oct 4, 2016 · 1 comment
Closed

Extend documentation #35

julkue opened this issue Oct 4, 2016 · 1 comment

Comments

@julkue
Copy link

julkue commented Oct 4, 2016

For example the following is missing:

  • An example with events
  • If the entire options are optional or if an empty object is required ({})
  • Passing parameters of event callbacks
  • Method example (e.g. instance.enable())
  • Explicitly named option types (boolean, number, ...)
  • ...
@sandstrom
Copy link
Collaborator

Happy to accept a PR! I'll close this issue for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sandstrom @julkue