Merge pull request #435 from vim-jp/revital-doc

Replace deprecated vital#of({plugin-name}) with vital#{plugin-name}#new()

Author: thinca

Changes

@@ -4,6 +4,9 @@
 	- open()
 	- is_cmdwin()
 	Use Vim.Buffer's one instead.
+aabb291268c0977e1444b0901e816db4467d6806
+	Modules: *
+	'vital#{plugin-name}#of()' was renamed to 'vital#{plugin-name}#new()'.
 982d3cb87ef788f4607fc61f1fd20ec2e3975479
 	Modules: Vim.Guard
 	Guard.store() API has changed to take a single List instance instead of arguments, due to the

README.md

@@ -103,7 +103,7 @@ Assuming your Vim plugin name is `ujihisa`. You can define your utility
 function set `ujihisa#util` just by
 
 ```vim
-let s:V = vital#of('ujihisa')
+let s:V = vital#ujihisa#new()
 function! ujihisa#util#system(...)
   return call(s:V.system, a:000, s:V)
 endfunction
@@ -117,7 +117,7 @@ Vital has module system. The below is an example to import/load a module
 
 ```vim
 " Recommented way
-let s:V = vital#of('ujihisa')
+let s:V = vital#ujihisa#new()
 let s:O = s:V.import('Data.OrderedSet')
 call s:O.f()
 ```
@@ -126,7 +126,7 @@ or
 
 ```vim
 " Recommended way only if you rarely use the module
-let s:V = vital#of('ujihisa')
+let s:V = vital#ujihisa#new()
 call s:V.load('Data.OrderedSet')
 call s:V.Data.OrderedSet.f()
 ```
@@ -135,7 +135,7 @@ or
 
 ```vim
 " Available, but we don't recommend this very much
-let s:V = vital#of('ujihisa')
+let s:V = vital#ujihisa#new()
 call s:V.import('Data.OrderedSet', s:)
 call s:f()
 ```

autoload/vital/_vital.vim

@@ -1,5 +1,5 @@
 let s:_plugin_name = expand('<sfile>:t:r')
 
 function! vital#{s:_plugin_name}#new() abort
-  return vital#{s:_plugin_name[1:]}#of()
+  return vital#{s:_plugin_name[1:]}#new()
 endfunction

autoload/vital/vital.vim

@@ -21,7 +21,7 @@ else
   endfunction
 endif
 
-function! vital#{s:plugin_name}#of() abort
+function! vital#{s:plugin_name}#new() abort
   return s:new(s:plugin_name)
 endfunction
 
@@ -170,7 +170,7 @@ function! s:_import(name) abort dict
   let s:loaded[a:name] = export_module
   if has_key(module, '_vital_loaded')
     try
-      call module._vital_loaded(vital#{s:plugin_name}#of())
+      call module._vital_loaded(vital#{s:plugin_name}#new())
     catch
       unlet s:loaded[a:name]
       throw 'vital: fail to call ._vital_loaded(): ' . v:exception

autoload/vitalizer.vim

@@ -8,7 +8,7 @@ let s:LOADER_FILES = [
 \   'autoload/vital/vital.vim',
 \   'autoload/vital/_vital.vim',
 \ ]
-let s:V = vital#vital#of()
+let s:V = vital#vital#new()
 let s:P = s:V.import('Prelude')
 let s:L = s:V.import('Data.List')
 let s:S = s:V.import('Data.String')

doc/vital-assertion.txt

@@ -33,7 +33,7 @@ define({assert_command_name}, ...)                  *Vital.Assertion.define()*
 
        1) Succeeded
 >
-           let s:V = vital#of('vital')
+           let s:V = vital#{plugin-name}#new()
            let s:A = s:V.import('Assertion')
 
            call s:A.define('Assert', 1)
@@ -45,7 +45,7 @@ define({assert_command_name}, ...)                  *Vital.Assertion.define()*
 
        2) Failed
 >
-           let s:V = vital#of('vital')
+           let s:V = vital#{plugin-name}#new()
            let s:A = s:V.import('Assertion')
 
            call s:A.define('Assert', 1)
@@ -66,7 +66,7 @@ define({assert_command_name}, ...)                  *Vital.Assertion.define()*
 
        1) Succeeded
 >
-           let s:V = vital#of('vital')
+           let s:V = vital#{plugin-name}#new()
            let s:A = s:V.import('Assertion')
 
            call s:A.define('Assert', 1)
@@ -78,7 +78,7 @@ define({assert_command_name}, ...)                  *Vital.Assertion.define()*
 
        2) Failed
 >
-           let s:V = vital#of('vital')
+           let s:V = vital#{plugin-name}#new()
            let s:A = s:V.import('Assertion')
 
            call s:A.define('Assert', 1)

doc/vital-concurrent_process.txt

@@ -60,7 +60,7 @@ Note that this usage gives you little benefit to you comparing just to use
 system(), vimproc#system(), or Vital.Process.system(). Keep reading other
 examples before you try to use this for your own plugin ;)
 >
-	let s:CP = vital#of('vital').import('ConcurrentProcess')
+	let s:CP = vital#{plugin-name}#new().import('ConcurrentProcess')
 
 	function! s:list_files(path) abort
 	  let label = s:CP.of(['ls', a:path], '', [
@@ -92,7 +92,7 @@ Things to learn from this example:
 
 You can give text to stdin as well.
 >
-	let s:CP = vital#of('vital').import('ConcurrentProcess')
+	let s:CP = vital#{plugin-name}#new().import('ConcurrentProcess')
 
 	function! s:with_linenum(text) abort
 	  let label = s:CP.of('cat -n', '', [

doc/vital-data-bignum.txt

@@ -16,7 +16,7 @@ INTRODUCTION				*Vital.Data.BigNum-introduction*
 It provides some functions to manipulate multi precision integer.
 
 >
-	let s:V = vital#of("vital")
+	let s:V = vital#{plugin-name}#new()
 	let s:BigNum = s:V.import("Data.BigNum")
 
 	let x = s:BigNum.from_num(42)

doc/vital-data-closure.txt

@@ -18,7 +18,7 @@ INTRODUCTION				*Vital.Data.Closure-introduction*
 
 *Vital.Data.Closure* provides Closure object.
 >
-	let C = vital#of('vital').import('Data.Closure')
+	let C = vital#{plugin-name}#new().import('Data.Closure')
 <
 
 

doc/vital-data-counter.txt

@@ -18,7 +18,7 @@ INTRODUCTION				*Vital.Data.Counter-introduction*
 *Vital.Data.Counter* is a counter library to support convenient tallies.
 
 >
-	let s:V = vital#of('vital')
+	let s:V = vital#{plugin-name}#new()
 	let s:Counter = s:V.import('Data.Counter')
 	let s:Math = s:V.import('Math')