README.md: Properties are not methods

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head
Gergely Nagy 8 years ago
parent 853712eec1
commit 4d1a73f0b7

@ -72,16 +72,14 @@ changes key behaviour! Failing to do so may result in unpredictable behaviour.
## Plugin methods
The plugin provides the `Leader` object, with the following methods:
The plugin provides the `Leader` object, with the following methods and properties:
### `.dictionary`
> Tells `Leader` to use the specified dictionary. The dictionary is an array of
> `kaleidoscope::Leader::dictionary_t` elements. Each element is made up of two
> elements, the first being a list of keys, the second an action to perform when
> the sequence is found.
> Not strictly a method, it is a variable one can assign a new value to.
> Set this property to the dictionary `Leader` should use. The dictionary is an
> array of `kaleidoscope::Leader::dictionary_t` elements. Each element is made
> up of two elements, the first being a list of keys, the second an action to
> perform when the sequence is found.i
>
> The dictionary *MUST* reside in `PROGMEM`.
@ -97,8 +95,6 @@ The plugin provides the `Leader` object, with the following methods:
> sequence timed out, if there is a partial match with an action, that will be
> performed, otherwise the Leader sequence will simply reset.
>
> Not strictly a method, it is a variable one can assign a new value to.
>
> Defaults to 1000.
## Dependencies

Loading…
Cancel
Save