Many improvements to documentation #3177
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Improved clarity, grammar, consistency, punctuation, and formatting. Thank you for the great tool!
rom1v
reviewed
Apr 10, 2022
| @@ -772,7 +771,7 @@ Any <kbd>Ctrl</kbd> shortcut is forwarded to the device. In particular: | |||
| This typically works as you expect. | |||
|
|
|||
| The actual behavior depends on the active application though. For example, | |||
| _Termux_ sends SIGINT on <kbd>Ctrl</kbd>+<kbd>c</kbd> instead, and _K-9 Mail_ | |||
| `Termux` sends SIGINT on <kbd>Ctrl</kbd>+<kbd>c</kbd> instead, and `K-9 Mail` | |||
There was a problem hiding this comment.
(I prefer italic for program names.)
There was a problem hiding this comment.
Sounds good. What about for scrpy and adb?
Consistency will help add clarity. What do you think?
There was a problem hiding this comment.
I would say, as a general rule:
- italic when it's the program name ("the adb connection")
backquoteswhen it's the command ("runadb")
(Sometimes, the distinction is not clear.)
JohnVeness
reviewed
Apr 12, 2022
| @@ -162,7 +162,7 @@ You can also [build the app manually][BUILD]. | |||
|
|
|||
| ## Run | |||
|
|
|||
| Plug an Android device, and execute: | |||
| Plug in an Android device to your computer, and execute: | |||
There was a problem hiding this comment.
Hi, sorry for butting in, but I think "Plug an Android device into your computer" would be better.
JohnVeness
reviewed
Apr 12, 2022
| More precisely, hold <kbd>Ctrl</kbd> while pressing the left-click button. Until | ||
| the left-click button is released, all mouse movements scale and rotate the | ||
| content (if supported by the app) relative to the center of the screen. | ||
| More precisely, hold <kbd>Ctrl</kbd> down while pressing the left-click button. |
There was a problem hiding this comment.
I think "hold down Ctrl" sounds better than "hold Ctrl down".
|
I rebased, replaced some Please review 😉 Is it ok for both of you? Thank you. |
|
Looks good to me 👍 |
|
Merged: 3c8ebf9 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improved clarity, grammar, consistency, punctuation, and formatting.
Thank you for the great tool!