Feedback on README

[DamienCassou]

Here is some feedback regarding the README I just read. I can send a PR for some of these points if you want.

• "The default object bindings": in the table, I don't understand some lines, e.g., the first two. (ok, you explain them after, maybe you could say that in the table)
• Before understanding what the package is about, there are quite some lines to read. What about putting some examples right at the beginning (you already have them in "Basic Usage")
• "Create custom composable command": you could give a meaningful example. Something like, "suppose you have a function rename-variable-region that replaces all occurrences of a variable name in the region by another name, you can make it composable by..."
• "Composable mark mode": I understand I can type "C-SPC l", but I don't know what this will do
• "Prefix arguments": I guess it could be clearer with more examples, right from the beginning.
• "With pair movements": what does M-w . f do?

[paldepind]

Thank you very much for your valuable feedback.

"The default object bindings": in the table, I don't understand some lines, e.g., the first two. (ok, you explain them after, maybe you could say that in the table)

I agree. Inserting a reference to the section on prefix arguments would be a good idea.

Before understanding what the package is about, there are quite some lines to read. What about putting some examples right at the beginning (you already have them in "Basic Usage")

I think this is a good idea. Just to show what the package can do without people having to understand it.

"Create custom composable command": you could give a meaningful example. Something like, "suppose you have a function rename-variable-region that replaces all occurrences of a variable name in the region by another name, you can make it composable by..."

Good idea and a fine example.

"Composable mark mode": I understand I can type "C-SPC l", but I don't know what this will do

It activates the object bindings that are shown in the section on object bindings. I don't now how to explain it better. Maybe add an example? Or make the text "object bindings" a link to the section on the topic?

"With pair movements": what does M-w . f do?

It actually does the same as M-w . f. With pair movements there is no difference between , and ..

I'd like a PR on the points on which you have ideas for improvements! Afterwards I could take a shot :smile:

[paldepind]

I've expanded the documentation about composable-mark-mode. Does it make sense to you?

[DamienCassou]

Pay attention, you have conflict markers. Beyond that, I like it. Thanks

[paldepind]

Oops. I've gotten rid of the conflict markers.