search

thoughtbot / vim-rspec

Run Rspec specs from Vim
https://robots.thoughtbot.com
MIT License
656 stars 108 forks source link

Add a help file #108

Closed dgmstuart closed 7 years ago

dgmstuart commented 8 years ago

I use vim-rspec every day, so this is my way of giving back :smile:

I guess on the one hand this is one more thing to maintain, but it's pretty useful to be able to get at docs within vim without having to go out to the web.

The rspec_command and rspec_runner documentation is basically just adapted from the readme, but I've added some notes about the four different ways of running specs, based on looking at the source.

I see there's an updated readme section about rspec_runner on https://github.com/thoughtbot/vim-rspec/tree/gl-require-gui-runner (which is not currently merged). I decided not to base the help file off that, but I'm happy to do so if you think it makes more sense.

Structure is based on https://github.com/tpope/vim-dispatch/blob/master/doc/dispatch.txt

dgmstuart commented 8 years ago

@gylaz oops - looks like I commented on an outdated diff. I've made that change and force-pushed it. Anything else I can do?

dgmstuart commented 7 years ago

@gylaz anything I can do to help get this merged?

dgmstuart commented 7 years ago

Rebased

gylaz commented 7 years ago

Merged. Thanks @dgmstuart!

dgmstuart commented 7 years ago

Great! Thanks for merging @gylaz and all your work on this plugin 😊