From a53d4c89eec3a2203e6f2c4a8ffe6850b9b51626 Mon Sep 17 00:00:00 2001 From: Simon Lydell Date: Sat, 20 Aug 2016 09:21:10 +0200 Subject: [PATCH] Improve docs on "options object" with examples See #791. --- documentation/api.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/api.md b/documentation/api.md index 8361987..7408be6 100644 --- a/documentation/api.md +++ b/documentation/api.md @@ -763,10 +763,11 @@ whose keys are VimFx pref names. Note that the values are not just simply `vimfx.get(pref)` for the `pref` in question; they are _parsed_ (`parse(vimfx.get(pref))`): -- Space-separated prefs are parsed into arrays of strings. +- Space-separated prefs are parsed into arrays of strings. For example, + `pattern_attrs: ['class']`. -- `blacklist` and `{prev,next}_patterns` are parsed into arrays of regular - expressions. +- `blacklist`, `prev_patterns` and `next_patterns` are parsed into arrays of + regular expressions. For example, `prev_patterns: [/\bnavPrev\b/]`. (See [parse-prefs.coffee] for all details.) -- 2.39.3