Skip to content

Commit fb55b1c

Browse files
authored
chore: minor updates to two api argument descriptions (#252)
* change consumption credit to event credit * update this description per ray
1 parent 8c06346 commit fb55b1c

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

card.aux.serial.req.notecard.api.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"type": "boolean"
2323
},
2424
"max": {
25-
"description": "The maximum amount of data to send per session, in bytes. This is typically set to the size of the receive buffer on the host minus `1`. For example, `note-arduino` uses a buffer size of `(SERIAL_RX_BUFFER_SIZE - 1)`.",
25+
"description": "The maximum amount of data, in bytes, that can be sent in a single transmission before the Notecard pauses to allow the host to process incoming data. This value should be set to the size of the host's serial receive buffer minus `1`, which represents the number of bytes the host can absorb before the sender must delay due to the absence of flow control. For example, `note-arduino`` uses a buffer size of `(SERIAL_RX_BUFFER_SIZE - 1)`.",
2626
"type": "integer"
2727
},
2828
"minutes": {

card.restart.req.notecard.api.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
"annotations": [
4949
{
5050
"title": "warning",
51-
"description": "Calls to `card.restart` are not supported for use in production applications as they can cause increased cellular data and consumption credit usage."
51+
"description": "Calls to `card.restart` are not supported for use in production applications as they can cause increased cellular data and event credit usage."
5252
}
5353
],
5454
"samples": [

0 commit comments

Comments
 (0)