Skip to content

Commit 0473528

Browse files
committed
adding readme in features
for relish and other small documentation tidy up
1 parent 9a4af19 commit 0473528

File tree

3 files changed

+30
-5
lines changed

3 files changed

+30
-5
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ I will go with it (clone at your own risk).
3535
:RRenameInstanceVariable - Rename Instance Variable (visual selection, *REQUIRES matchit.vim*)
3636
:RExtractMethod - Extract Method (visual selection, *REQUIRES matchit.vim*)
3737

38-
Default bindings:
38+
## Default bindings:
3939

4040
:nnoremap <leader>rap :RAddParameter<cr>
4141
:nnoremap <leader>rcpc :RConvertPostConditional<cr>

features/README.markdown

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Ruby Refactoring Tool for Vim
2+
3+
## Issues
4+
5+
If you identify any issues or specific funtionality you would like to see added, write the Cucumber feature and submit an [issue](https://github.com/ecomba/vim-ruby-refactoring/issues) or a [pull](https://github.com/ecomba/vim-ruby-refactoring/pulls) request:
6+
7+
@issue
8+
Scenario: Add a parameter to a method defined with no parameters or parentheses
9+
Given I have the following code:
10+
"""
11+
def set_name
12+
end
13+
"""
14+
When I select the method and execute:
15+
"""
16+
:RAddParameter
17+
"""
18+
And I fill in the parameter "name"
19+
Then I should see:
20+
"""
21+
def set_name(name)
22+
end
23+
24+
"""

features/add_parameter.feature

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
Feature: Add Parameter :RAddParameter
2-
This refactoring should add a new parameter to a method definition, regardless of how many the method already has.
3-
### Shortcuts:
4-
### <leader>rap
5-
### :RAddParameter
2+
This refactoring should add a new parameter to a method definition, regardless of how many the method already has.
3+
4+
Shortcuts:
5+
<leader>rap
6+
:RAddParameter
67

78
Scenario: Add a parameter to a method defined with no parameters or parentheses
89
Given I have the following code:

0 commit comments

Comments
 (0)