From 96148fcf1db3d7fe87240c3b03bd09675f5b2a49 Mon Sep 17 00:00:00 2001 From: cpfaff Date: Tue, 30 Oct 2012 11:23:24 +0100 Subject: [PATCH 1/4] improves english of the documentation a bit --- doc/neosnippet.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/neosnippet.txt b/doc/neosnippet.txt index 3cc5dce..9f43ba7 100644 --- a/doc/neosnippet.txt +++ b/doc/neosnippet.txt @@ -152,7 +152,7 @@ g:neosnippet#disable_select_mode_mappings Note: |g:neocomplcache_disable_select_mode_mappings| is an obsolete name. - Default value is 1. + The default value is 1. g:neosnippet#disable_runtime_snippets *g:neosnippet#disable_runtime_snippets* @@ -173,7 +173,7 @@ g:neosnippet#disable_runtime_snippets \ } " Works like g:neocomplcache_snippets_disable_runtime_snippets - " (Disable all runtime snippets). + " which disables all runtime snippets let g:neosnippet#disable_runtime_snippets = { \ '_' : 1, \ } @@ -202,7 +202,7 @@ s_(neosnippet_expand_or_jump) *(neosnippet_jump_or_expand)* s_(neosnippet_jump_or_expand) *s_(neosnippet_jump_or_expand)* - Jump to next placeholder. If there is no placeholder, expand a + Jump to the next placeholder. If there is no placeholder, expand a multiline cursor snippet. *(neocomplcache_snippets_jump)* @@ -217,18 +217,18 @@ s_(neosnippet_expand) *(neocomplcache_snippets_force_expand)* Note: |(neocomplcache_snippets_force_expand)| is - obsolete name. + an obsolete name. (neosnippet_jump) *(neosnippet_jump)* s_(neosnippet_jump) *s_(neosnippet_jump)* - Jump to next place holder. Do not expand any snippet. When + Jump to the next place holder. Do not expand any snippet. When you do not want to expand a snippet name, use this keymapping. *(neocomplcache_snippets_force_jump)* Note: |(neocomplcache_snippets_force_jump)| is - obsolete name. + an obsolete name. i_(neosnippet_start_unite_snippet) *i_(neosnippet_start_unite_snippet)* From 062e92d5e4b50f601e82f9132a7bebcabd6ecb5c Mon Sep 17 00:00:00 2001 From: cpfaff Date: Tue, 30 Oct 2012 11:26:01 +0100 Subject: [PATCH 2/4] improves introduction --- doc/neosnippet.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/neosnippet.txt b/doc/neosnippet.txt index 9f43ba7..f102e79 100644 --- a/doc/neosnippet.txt +++ b/doc/neosnippet.txt @@ -40,9 +40,10 @@ Changelog |neosnippet-changelog| ============================================================================== INTRODUCTION *neosnippet-introduction* -This source analyzes snippet files for completion, offers functionality -similar to snipMate.vim or snippetsEmu.vim. Since you can choose snippet with -neocomplcache interface, you might have less trouble learning it. +This plugin analyzes snippet files which you can use for completion. It offers +functionality similar to snipMate.vim or snippetsEmu.vim. Since you can choose +snippets with the neocomplcache interface, you might have less trouble learning +it because you do not have to remember each snippet name. ============================================================================== INSTALL *neosnippet-install* From 11fb98aa9f52ec9a21137ef889b8ad4dbfeb77a5 Mon Sep 17 00:00:00 2001 From: cpfaff Date: Tue, 30 Oct 2012 11:41:15 +0100 Subject: [PATCH 3/4] improves english of the key mappings section --- doc/neosnippet.txt | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/doc/neosnippet.txt b/doc/neosnippet.txt index f102e79..90dc0ea 100644 --- a/doc/neosnippet.txt +++ b/doc/neosnippet.txt @@ -63,7 +63,7 @@ COMMANDS *neosnippet-commands* :NeoSnippetMakeCache [filetype] *:NeoSnippetMakeCache* - Creates a cache for the [filetype] snippets. It automatically + Creates a cache for the given [filetype] snippets. It automatically choses the current buffer's file type unless you specify one by [filetype]. @@ -193,28 +193,28 @@ KEY MAPPINGS *neosnippet-key-mappings* s_(neosnippet_expand_or_jump) *s_(neosnippet_expand_or_jump)* Expands a cursor snippet of plural lines. When there is no - snippet, jumps to the next placeholder. + snippet, it jumps to the next placeholder. *(neocomplcache_snippets_expand)* - Note: |(neocomplcache_snippets_expand)| is obsolete + Note: |(neocomplcache_snippets_expand)| is an obsolete name. (neosnippet_jump_or_expand) *(neosnippet_jump_or_expand)* s_(neosnippet_jump_or_expand) *s_(neosnippet_jump_or_expand)* - Jump to the next placeholder. If there is no placeholder, expand a - multiline cursor snippet. + Jump to the next placeholder. If there is no placeholder, it expand a + multi line cursor snippet. *(neocomplcache_snippets_jump)* - Note: |(neocomplcache_snippets_jump)| is obsolete + Note: |(neocomplcache_snippets_jump)| is an obsolete name. (neosnippet_expand) *(neosnippet_expand)* s_(neosnippet_expand) *s_(neosnippet_expand)* - Expand a cursor snippet. Does nothing if there is no snippet. + Expand a cursor snippet. It does nothing if there is no snippet. *(neocomplcache_snippets_force_expand)* Note: |(neocomplcache_snippets_force_expand)| is @@ -225,7 +225,7 @@ s_(neosnippet_expand) s_(neosnippet_jump) *s_(neosnippet_jump)* Jump to the next place holder. Do not expand any snippet. When - you do not want to expand a snippet name, use this keymapping. + you do not want to expand a snippet name, use this key mapping. *(neocomplcache_snippets_force_jump)* Note: |(neocomplcache_snippets_force_jump)| is @@ -233,9 +233,8 @@ s_(neosnippet_jump) i_(neosnippet_start_unite_snippet) *i_(neosnippet_start_unite_snippet)* - Start unite snippet source. You can expand a snippet by unite - interface. - Note: |unite.vim| is required. + Starts the unite snippet source. You can expand a snippet by the + unite interface. Note: |unite.vim| is required. *(neocomplcache_start_unite_snippet)* Note: |(neocomplcache_start_unite_snippet)| is an obsolete @@ -243,7 +242,7 @@ i_(neosnippet_start_unite_snippet) x_(neosnippet_expand_target) *x_(neosnippet_expand_target)* - Expand inputted trigger by selected target text. + Expand the inputted trigger by selected target text. x_(neosnippet_register_oneshot_snippet) *x_(neosnippet_register_oneshot_snippet)* @@ -251,12 +250,12 @@ x_(neosnippet_register_oneshot_snippet) neosnippet#expandable() *neosnippet#expandable()* - Use this function with imap . It checks whether cursor - text is a snippet trigger or a placeholder exists in the - current buffer. It's useful for saving keymappings. - Return value is not just a boolean but either - 0: not found - 1: cursor text is a snippet trigger + You can use this function with imap . It checks whether the + cursor text is a snippet trigger or a placeholder. This is is useful + to save key mappings. The return values of the function are: + + 0: not found + 1: the cursor text is a snippet trigger 2: a placeholder exists in the current buffer 3: both found > @@ -273,9 +272,9 @@ neosnippet#expandable() neosnippet#jumpable() *neosnippet#jumpable()* - Use this function with imap . It checks whether cursor - text is an existing placeholder in current buffer. - Useful for saving keymappings. + Use this function with imap . It checks if the cursor + text is an existing placeholder in current buffer. This is + useful to save key mappings. *neocomplcache#sources#snippets_complete#jumpable()* Note: |neocomplcache#sources#snippets_complete#jumpable()| is From b8f267513df8a75e3516425004dc9067ca6ca5eb Mon Sep 17 00:00:00 2001 From: cpfaff Date: Tue, 30 Oct 2012 11:46:27 +0100 Subject: [PATCH 4/4] improves the documentation of the key mapping secion --- doc/neosnippet.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/neosnippet.txt b/doc/neosnippet.txt index 90dc0ea..65ed6c1 100644 --- a/doc/neosnippet.txt +++ b/doc/neosnippet.txt @@ -203,7 +203,7 @@ s_(neosnippet_expand_or_jump) *(neosnippet_jump_or_expand)* s_(neosnippet_jump_or_expand) *s_(neosnippet_jump_or_expand)* - Jump to the next placeholder. If there is no placeholder, it expand a + Jump to the next placeholder. If there is no placeholder, it expands a multi line cursor snippet. *(neocomplcache_snippets_jump)* @@ -234,7 +234,8 @@ s_(neosnippet_jump) i_(neosnippet_start_unite_snippet) *i_(neosnippet_start_unite_snippet)* Starts the unite snippet source. You can expand a snippet by the - unite interface. Note: |unite.vim| is required. + unite interface. Note: The plugin |unite.vim| is required for + that. *(neocomplcache_start_unite_snippet)* Note: |(neocomplcache_start_unite_snippet)| is an obsolete @@ -242,11 +243,11 @@ i_(neosnippet_start_unite_snippet) x_(neosnippet_expand_target) *x_(neosnippet_expand_target)* - Expand the inputted trigger by selected target text. + Expand the input trigger by a selected target text. x_(neosnippet_register_oneshot_snippet) *x_(neosnippet_register_oneshot_snippet)* - Register oneshot snippet in current buffer. + Register oneshot snippet in the current buffer. neosnippet#expandable() *neosnippet#expandable()*