Browse Source

doc: reword custom indices section

Marco Hinz 12 years ago
parent
commit
ceb0b082b6
1 changed files with 9 additions and 6 deletions
  1. 9 6
      doc/startify.txt

+ 9 - 6
doc/startify.txt

@@ -153,12 +153,6 @@ there are more paths to fill in the startify buffer than actual items in the
 custom list, the rest will be filled up using the default numbering scheme
 starting from 0.
 
-NOTE: There is no sanitizing going on, so you should know what you do!
-
-E.g. you don't want to use duplicates. Same for 'e', 'i', 'q'. Actually you
-can use them, but they would be overwritten by mappings for creating the empty
-buffer and quitting. You may want to keep 'j' and 'k', too.
-
 Example: let g:startify_custom_indices = ['a','s','d','f']
 
 This would result in:
@@ -171,6 +165,15 @@ This would result in:
     [1]  /last/recently/used/file6
     etc.
 
+NOTE: There is no sanitizing going on, so you should know what you're doing!
+
+Best practices:
+
+- do not use 'e', 'i' or 'q' (they will be overwritten anyway)
+- do not use duplicates (previous mappings will be overwritten)
+- do not uses empty strings (creates unreachable entries)
+- (you might want to keep 'j' and 'k' for navigation)
+
 
 ============-