decko icon indicating copy to clipboard operation
decko copied to clipboard

Published 20 hours ago • verified publisher icon developit

[DOCS] Better options documentaion

Open vahnag opened this issue 9 years ago • 1 comments

These things are unclear from the current documentation about the options:

  • How to use options
  • What are the default values

It is possible to look them up in source code, but I think, it would be nice to have them in docs.

vahnag avatar Mar 10 '16 17:03 vahnag

The default values are specified after the colon in the readme: delay: 0 or cache: {}. This could certainly be clearer, though. Good point about actual usage though, that is missing entirely. They all follow the same pattern (@foo(options)), but it's probably worth just showing it explicitly for each.

developit avatar Mar 10 '16 17:03 developit