Skip to content

Commit c4ce03b

Browse files
committed
Prefer commands without R prefix in documentation
1 parent c8a7692 commit c4ce03b

File tree

1 file changed

+33
-28
lines changed

1 file changed

+33
-28
lines changed

doc/rails.txt

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ actually edit a file from a Rails application.
6262
window. If the delay in loading is too long, you
6363
might like :Rake log:clear.
6464

65-
*rails-:Rpreview*
66-
:Rpreview [path] Open the given [path] for the current app in a
67-
browser. The host and port are determined by applying
68-
some netstat/lsof trickery to the current server pid.
69-
If no server is running, Pow is consulted, and if all
65+
*rails-:Preview* *rails-:Rpreview*
66+
:Preview [path] Open the given path for the current app in a browser.
67+
The host and port are determined by applying some
68+
netstat/lsof trickery to the current server pid. If
69+
no server is running, Pow is consulted, and if all
7070
else fails, a default of localhost:3000 is used. If
71-
[path] is omitted, a default is used based on the
71+
no path is given, a default is used based on the
7272
current file and the application's routes. The
7373
default is overridden by comments like the following
7474
that are either before the current method call or at
@@ -82,8 +82,8 @@ actually edit a file from a Rails application.
8282
>
8383
:command -bar -nargs=1 OpenURL :!open <args>
8484
<
85-
*rails-:Rpreview!*
86-
:Rpreview! [path] Like :Rpreview, but open the path inside Vim using
85+
*rails-:Preview!* *rails-:Rpreview!*
86+
:Preview! [path] Like :Preview, but open the path inside Vim using
8787
|netrw| instead.
8888

8989
*rails-:Rrefresh*
@@ -427,11 +427,16 @@ A limited amount of completion with <Tab> is supported.
427427
*rails-:Rscript*
428428
:Rscript {command} [options]
429429
Deprecated alias for |:Rails| {command}. Defaults to
430-
calling |:Rails| console.
430+
calling |:Console|.
431431

432-
*rails-:Rrunner*
433-
:[range]Rrunner [file] Run the given file or code with rails runner and load
434-
:Rrunner {code} the results in to the quickfix list, using the error
432+
*rails-:Console*
433+
:Console {options} Launch rails console {options}. If dispatch.vim's
434+
:Start is available, that is used. Otherwise,
435+
executes directly in the foreground.
436+
437+
*rails-:Runner* *rails-:Rrunner*
438+
:[range]Runner [file] Run the given file or code with rails runner and load
439+
:Runner {code} the results in to the quickfix list, using the error
435440
parser from the "ruby" |:compiler|. If the file looks
436441
like a test, spec, or cucumber feature, the
437442
"rubyunit", "rspec", or "cucumber" |:compiler| will be
@@ -447,22 +452,22 @@ A limited amount of completion with <Tab> is supported.
447452
*rails-:Rpp*
448453
:[range]Rpp {code} Like :Rp, but with pp (pretty print).
449454

450-
*rails-:Rgenerate*
451-
:Rgenerate {options} Calls rails generate {options} and loads the
455+
*rails-:Generate* *rails-:Rgenerate*
456+
:Generate {options} Invoke rails generate {options} and loads the
452457
generated files into the quickfix list. Use ! to
453458
surpress jumping to the first file.
454459

455-
*rails-:Rdestroy*
456-
:Rdestroy {options} Calls rails destroy {options} and loads the destroyed
460+
*rails-:Destroy* *rails-:Rdestroy*
461+
:Destroy {options} Invoke rails destroy {options} and loads the destroyed
457462
files into the quickfix list.
458463

459-
*rails-:Rserver*
460-
:Rserver {options} Launches rails server {options} in the background.
461-
If dispatch.vim's :Start is available, that is used.
464+
*rails-:Server* *rails-:Rserver*
465+
:Server {options} Launch rails server {options} in the background. If
466+
dispatch.vim's :Start is available, that is used.
462467
Otherwise, the --daemon option is passed in.
463468

464-
*rails-:Rserver!*
465-
:Rserver! {options} Kill the pid found in tmp/pids/server.pid and then
469+
*rails-:Server!* *rails-:Rserver!*
470+
:Server! {options} Kill the pid found in tmp/pids/server.pid and then
466471
invoke |:Rserver|.
467472

468473
REFACTORING HELPERS *rails-refactoring*
@@ -472,19 +477,19 @@ A few features are dedicated to helping you refactor your code.
472477
Partial Extraction ~
473478
*rails-partials*
474479

475-
The :Rextract command can be used to extract part of a view to a partial, part
480+
The :Extract command can be used to extract part of a view to a partial, part
476481
of a helper to another helper, or part of a model or controller to a concern.
477482

478-
*rails-:Rextract*
479-
:[range]Rextract [{controller}/]{name}
483+
*rails-:Extract* *rails-:Rextract*
484+
:[range]Extract [{controller}/]{name}
480485
Create a {name} partial from [range] lines (default:
481486
current line). Only available in views.
482487

483-
:[range]Rextract {helper}
488+
:[range]Extract {helper}
484489
Create a {name} helper from [range] lines (default:
485490
current line). Only available in helpers.
486491

487-
:[range]Rextract {concern}
492+
:[range]Extract {concern}
488493
Create a {name} concern from [range] lines (default:
489494
current line). Only available in models and
490495
controllers.
@@ -758,7 +763,7 @@ The full list of available options is as follows:
758763
current 'define' match (typically a method).
759764
*rails-projection-test*
760765
"test" ~
761-
Determines the default test file to run with |rails-:Rrunner| and
766+
Determines the default test file to run with |rails-:Runner| and
762767
|rails-:Rake|. Also serves as a default for "alternate".
763768
*rails-projection-task*
764769
"task" ~
@@ -769,7 +774,7 @@ The full list of available options is as follows:
769774
when a line number is given, and the second when it's omitted.
770775
*rails-projection-compiler*
771776
"compiler" ~
772-
Determines the |:compiler| plugin to use with |rails-:Rrunner|.
777+
Determines the |:compiler| plugin to use with |rails-:Runner|.
773778
*rails-projection-keywords*
774779
"keywords" ~
775780
Provides a whitespace delimited list of keywords to syntax highlight.

0 commit comments

Comments
 (0)