Skip to content

Commit dc14579

Browse files
committed
Copy edit keyboardPrint{,ln}.adoc
- a string is sent as multiple keystrokes, not as a single keystroke - these functions return the number of keystrokes sent, which is far smaller than the number of bytes.
1 parent 251e4d2 commit dc14579

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

Language/Functions/USB/Keyboard/keyboardPrint.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: Keyboard.print()
1414

1515
[float]
1616
=== Description
17-
Sends a keystroke to a connected computer.
17+
Sends one or more keystrokes to a connected computer.
1818

1919
`Keyboard.print()` must be called after initiating link:../keyboardbegin[Keyboard.begin()].
2020
[%hardbreaks]
@@ -29,12 +29,12 @@ Sends a keystroke to a connected computer.
2929
[float]
3030
=== Parameters
3131
`character`: a char or int to be sent to the computer as a keystroke. +
32-
`characters`: a string to be sent to the computer as a keystroke.
32+
`characters`: a string to be sent to the computer as keystrokes.
3333

3434

3535
[float]
3636
=== Returns
37-
Number of bytes sent. Data type: `size_t`.
37+
Number of keystrokes sent. Data type: `size_t`.
3838

3939
--
4040
// OVERVIEW SECTION ENDS

Language/Functions/USB/Keyboard/keyboardPrintln.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ title: Keyboard.println()
1414

1515
[float]
1616
=== Description
17-
Sends a keystroke to a connected computer, followed by a newline and carriage return.
17+
Sends one or more keystrokes to a connected computer, followed by a newline and carriage return.
1818

1919
`Keyboard.println()` must be called after initiating link:../keyboardbegin[Keyboard.begin()].
2020
[%hardbreaks]
@@ -30,12 +30,12 @@ Sends a keystroke to a connected computer, followed by a newline and carriage re
3030
[float]
3131
=== Parameters
3232
`character`: a char or int to be sent to the computer as a keystroke, followed by newline and carriage return. +
33-
`characters`: a string to be sent to the computer as a keystroke, followed by a newline and carriage return.
33+
`characters`: a string to be sent to the computer as keystrokes, followed by a newline and carriage return.
3434

3535

3636
[float]
3737
=== Returns
38-
Number of bytes sent. Data type: `size_t`.
38+
Number of keystrokes sent. Data type: `size_t`.
3939

4040
--
4141
// OVERVIEW SECTION ENDS

0 commit comments

Comments
 (0)