Skip to content

Commit fe18398

Browse files
committed
Specify that we are reading/writing bytes
1 parent 2752c88 commit fe18398

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/ebb.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -445,10 +445,10 @@ class EiBotBoard {
445445
}
446446

447447
/**
448-
* Read memory address.
448+
* Read the byte value at a memory address.
449449
* See {@link https://evil-mad.github.io/EggBot/ebb.html#MR}.
450450
* @param {number} address - Address to read (0 to 4095).
451-
* @returns {Promise<number>} - Resolves with the value at the given address.
451+
* @returns {Promise<number>} - Resolves with the byte value at the given address.
452452
*/
453453
async memoryRead(address) {
454454
if (address < 0 || address > 4095) {
@@ -467,10 +467,10 @@ class EiBotBoard {
467467
}
468468

469469
/**
470-
* Write given memory address.
470+
* Write a byte value at the given memory address.
471471
* See {@link https://evil-mad.github.io/EggBot/ebb.html#MW}.
472472
* @param {number} address - Address to write (0 to 4095).
473-
* @param {number} value - Value to write (0 to 255).
473+
* @param {number} value - Byte value to write (0 to 255).
474474
* @returns {Promise<void>} - Resolves after the command has been acknowledged.
475475
*/
476476
async memoryWrite(address, value) {

0 commit comments

Comments
 (0)