From 56cf06b754c8a1d544d3e834609afdbaf1479c9e Mon Sep 17 00:00:00 2001
From: Wang Shidong <wsdjeg@outlook.com>
Date: Mon, 10 Aug 2020 22:20:00 +0800
Subject: [PATCH] Update doc for lang#r layer (#3699)

---
 autoload/SpaceVim/layers/lang/r.vim | 31 ++++++++++++
 doc/SpaceVim.txt                    | 76 ++++++++++++++++++++---------
 2 files changed, 85 insertions(+), 22 deletions(-)

diff --git a/autoload/SpaceVim/layers/lang/r.vim b/autoload/SpaceVim/layers/lang/r.vim
index e62d1cd7a..dc71fbef7 100644
--- a/autoload/SpaceVim/layers/lang/r.vim
+++ b/autoload/SpaceVim/layers/lang/r.vim
@@ -6,6 +6,37 @@
 " License: GPLv3
 "=============================================================================
 
+""
+" @section lang#ring, layer-lang-r
+" @parentsection layers
+" This layer is for r development, disabled by default, to enable this
+" layer, add following snippet to your SpaceVim configuration file.
+" >
+"   [[layers]]
+"     name = 'lang#r'
+" <
+"
+" @subsection Key bindings
+"
+" The command of code runner for R is `"R <%s"`
+" `%s` will be replaced to the path of current R file.
+" >
+"   Key             Function
+"   --------------------------------
+"   SPC l r         run current file
+" <
+"
+" This layer also provides REPL support for r, the key bindings are:
+" >
+"   Key             Function
+"   ---------------------------------------------
+"   SPC l s i       Start a inferior REPL process
+"   SPC l s b       send whole buffer
+"   SPC l s l       send current line
+"   SPC l s s       send selection text
+" <
+"
+
 function! SpaceVim#layers#lang#r#plugins() abort
   let plugins = []
   call add(plugins, ['wsdjeg/Nvim-R', {'merged' : 0}])
diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt
index 496a02331..70df4de51 100644
--- a/doc/SpaceVim.txt
+++ b/doc/SpaceVim.txt
@@ -134,28 +134,29 @@ CONTENTS                                                   *SpaceVim-contents*
       58. lang#puppet.............................|SpaceVim-layer-lang-puppet|
       59. lang#python.............................|SpaceVim-layer-lang-python|
       60. lang#racket.............................|SpaceVim-layer-lang-racket|
-      61. lang#ring.................................|SpaceVim-layer-lang-ring|
-      62. lang#ruby.................................|SpaceVim-layer-lang-ruby|
-      63. lang#rust.................................|SpaceVim-layer-lang-rust|
-      64. lang#scala...............................|SpaceVim-layer-lang-scala|
-      65. lang#scheme.............................|SpaceVim-layer-lang-scheme|
-      66. lang#sh.....................................|SpaceVim-layer-lang-sh|
-      67. lang#swig.................................|SpaceVim-layer-lang-swig|
-      68. lang#tcl...................................|SpaceVim-layer-lang-tcl|
-      69. lang#toml.................................|SpaceVim-layer-lang-toml|
-      70. lang#typescript.....................|SpaceVim-layer-lang-typescript|
-      71. lang#v.......................................|SpaceVim-layer-lang-v|
-      72. lang#vbnet...............................|SpaceVim-layer-lang-vbnet|
-      73. lang#xml...................................|SpaceVim-layer-lang-xml|
-      74. lang#xquery.............................|SpaceVim-layer-lang-xquery|
-      75. language server protocol........................|SpaceVim-layer-lsp|
-      76. leaderf.....................................|SpaceVim-layer-leaderf|
-      77. operator...................................|SpaceVim-layer-operator|
-      78. shell.........................................|SpaceVim-layer-shell|
-      79. test...........................................|SpaceVim-layer-test|
-      80. tmux...........................................|SpaceVim-layer-tmux|
-      81. tools#dash...............................|SpaceVim-layer-tools-dash|
-      82. tools#zeal...............................|SpaceVim-layer-tools-zeal|
+      61. lang#ring....................................|SpaceVim-layer-lang-r|
+      62. lang#ring.................................|SpaceVim-layer-lang-ring|
+      63. lang#ruby.................................|SpaceVim-layer-lang-ruby|
+      64. lang#rust.................................|SpaceVim-layer-lang-rust|
+      65. lang#scala...............................|SpaceVim-layer-lang-scala|
+      66. lang#scheme.............................|SpaceVim-layer-lang-scheme|
+      67. lang#sh.....................................|SpaceVim-layer-lang-sh|
+      68. lang#swig.................................|SpaceVim-layer-lang-swig|
+      69. lang#tcl...................................|SpaceVim-layer-lang-tcl|
+      70. lang#toml.................................|SpaceVim-layer-lang-toml|
+      71. lang#typescript.....................|SpaceVim-layer-lang-typescript|
+      72. lang#v.......................................|SpaceVim-layer-lang-v|
+      73. lang#vbnet...............................|SpaceVim-layer-lang-vbnet|
+      74. lang#xml...................................|SpaceVim-layer-lang-xml|
+      75. lang#xquery.............................|SpaceVim-layer-lang-xquery|
+      76. language server protocol........................|SpaceVim-layer-lsp|
+      77. leaderf.....................................|SpaceVim-layer-leaderf|
+      78. operator...................................|SpaceVim-layer-operator|
+      79. shell.........................................|SpaceVim-layer-shell|
+      80. test...........................................|SpaceVim-layer-test|
+      81. tmux...........................................|SpaceVim-layer-tmux|
+      82. tools#dash...............................|SpaceVim-layer-tools-dash|
+      83. tools#zeal...............................|SpaceVim-layer-tools-zeal|
   7. Usage....................................................|SpaceVim-usage|
       1. custom_plugins........................|SpaceVim-usage-custom_plugins|
       2. tasks..........................................|SpaceVim-usage-tasks|
@@ -2663,6 +2664,37 @@ This layer also provides REPL support for racket, the key bindings are:
 <
 
 
+==============================================================================
+LANG#RING                                              *SpaceVim-layer-lang-r*
+
+This layer is for r development, disabled by default, to enable this layer,
+add following snippet to your SpaceVim configuration file.
+>
+  [[layers]]
+    name = 'lang#r'
+<
+
+KEY BINDINGS
+
+The command of code runner for R is `"R <%s"` `%s` will be replaced to the
+path of current R file.
+>
+  Key             Function
+  --------------------------------
+  SPC l r         run current file
+<
+
+This layer also provides REPL support for r, the key bindings are:
+>
+  Key             Function
+  ---------------------------------------------
+  SPC l s i       Start a inferior REPL process
+  SPC l s b       send whole buffer
+  SPC l s l       send current line
+  SPC l s s       send selection text
+<
+
+
 ==============================================================================
 LANG#RING                                           *SpaceVim-layer-lang-ring*