Add keybindings to the README file.

pezra / rspec-mode

An RSpec minor mode for Emacs

257 stars 112 forks source link

Add keybindings to the README file. #125

Closed imtayadeway closed 9 years ago

imtayadeway commented 9 years ago

I added the keybindings to the README as I've grown accustomed to finding them there (I'm thinking of Projectile, Rubocop mode, etc...) I missed the first few times I visited the project that they were documented in the rspec-mode.el file itself. Not a big deal if you'd prefer not to have them here though.

dgutov commented 9 years ago

I don't mind the idea, but the resulting table looks very cramped.

imtayadeway commented 9 years ago

@dgutov I guess I could transpose the command and keybinding columns, and just delete the command column?

dgutov commented 9 years ago

Not sure what's the best course of action. Descriptions are useful, and if anything, it makes sense to have them in README.

Maybe some command names should be shortened, and the descriptions trimmed a bit.

pezra commented 9 years ago

Moving the keybindings to the left most column seems appropriate since the are the thing most people will care about the most. A description seem like the second most important thing, so having them in the second column makes sense. I like the command column but i don't think it is critical. If we keep it we should drop the M-x prefix in the table. (That will save a little space and it's not always true anyway. For instance, in my setup it is H-a).

I guess lean toward keeping all three columns, but rearranging them.

pezra commented 9 years ago

I think each of the three tables should have a title describing it and that their columns should all be named the same. Having to look at column headers to figure out what is in the table is a bit too subtle.

imtayadeway commented 9 years ago

@pezra I rearranged the columns and added the titles as suggested. I decided to remove the third column, but happy to put it back. I think the resulting table is more concise and readable, and has everything I would probably want to know at a glance.

dgutov commented 9 years ago

I think there are two things left to decide here:

What to do with the almost-same info at the top of rspec-mode.el? It's less readable that this table. Maybe remove it and just refer to README? Or mention the different minor modes, which files they get enabled in, and how to look at the list of available commands (C-c , C-h).
In the README, the headings based on the minor modes aren't too useful for a new user. Maybe change them to describe the kinds of files or buffers the bindings are supposed to work in (Ruby source files, Dired buffers, Ruby spec files).

pezra commented 9 years ago

What to do with the almost-same info at the top of rspec-mode.el? [...] Maybe remove it and just refer to README?

:+1: I think just refer to the readme.

Maybe change [the table headings] to describe the kinds of files or buffers the bindings are supposed to work in (Ruby source files, Dired buffers, Ruby spec files).

:+1:

imtayadeway commented 9 years ago

@pezra @dgutov can you rereview?

pezra commented 9 years ago

@imtayadeway, looks great. Thanks.