search

Julow / Unexpected-Keyboard

A lightweight virtual keyboard for developers.
GNU General Public License v3.0
1.25k stars 168 forks source link

Flesh out custom layout doc; fix typos in #650 #651

Closed Spike-from-NH closed 2 weeks ago

Spike-from-NH commented 2 weeks ago

Thanks for this detailed review! You make good points. The only one I disagree with is the one on the modmap; my modmap maps "the " to "The ". (Perhaps it only affects the "t"?) And I don't understand the final one—Are you saying that <fn transforms a key only if no <shift did?

It looks like you want me to make suitable edits to my fork before accepting the merge request. Okay, but this process is confusing; where you have made an exact suggestion (I agree with these) and Github is asking me to "Commit suggestion", does that perform an edit on my file? Does the issue then go away, or must I keep track of which issues I have and haven't dealt with?

Spike-from-NH commented 2 weeks ago

Regarding new lines 47 and 49, you seem to be saying that the percentage of the screen height that Settings lets the keyboard occupy is 4.0 units (rather than my guess that you scale row heights to comply with Settings)—so a keyboard with other than 4.0 will have a height other than that specified in Settings. If so, we ought to say so, in order to say what "1.0" means.

Spike-from-NH commented 2 weeks ago

And on your first two comments: I added this Intro to explain why the document exists, by contrasting custom layouts to built-in ones. And it might be read not only by users who have decided to make a custom layout but by users who want to know what their options are. I think the built-in layouts, though not covering a large percentage of languages, will satisfy a large percentage of users, but you're right, the document oughtn't try to talk them out of a custom layout.

Spike-from-NH commented 2 weeks ago

I revised the file generally. In the 4 cases you offered wording, I agreed with 3. (I made 2 a "batch" but was never asked to do anything with it.) My remaining confusion is confined to keyboard height and modmap.

Julow commented 2 weeks ago

The only one I disagree with is the one on the modmap; my modmap maps "the " to "The ". (Perhaps it only affects the "t"?)

That's a single key outputting several characters. The word "sequence" is ambiguous in the sense that's it's not possible to specify a sequence of several keys (eg. it's not possible to specify "selectAll cut").

Are you saying that <fn transforms a key only if no <shift did?

For the gestures only, yes.

Github is asking me to "Commit suggestion", does that perform an edit on my file?

Yes, Github will modify the file in your fork and make a commit. If you have the code locally, you'll have to pull. To simplify things a bit, you can copy paste the suggestions. Or even, take inspiration from them and change the doc in an other way.

so a keyboard with other than 4.0 will have a height other than that specified in Settings

Yes. But I think it's not necessary to specify that for the reason I mentionned above: That's not intended. No users of 3-rows or 5-rows layouts have complained but this behavior has not been made on purpose.

Spike-from-NH commented 2 weeks ago

The document now seems to include the 2 of your edits I put in the "batch."

Regarding keyboard height, I'll document it as I now understand it. If you feel it still restricts future development options, we can delete it.

I've filed the Pull Request because I can't tell if I missed anything. If you accept it but I have missed something, I'll promptly do another round.