Skip to content

Commit 46298dd

Browse files
committed
PacketBuffer doc fixes
1 parent 241d7e2 commit 46298dd

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

shared-bindings/_bleio/PacketBuffer.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
//|
4343
//| Accumulates a Characteristic's incoming packets in a FIFO buffer and facilitates packet aware
4444
//| outgoing writes. A packet's size is either the characteristic length or the maximum transmission
45-
//| unit (MTU), whichever is smaller. The MTU can change so check `incoming_packet_length` before creating a
45+
//| unit (MTU), whichever is smaller. The MTU can change so check `packet_size` before creating a
4646
//| buffer to store data.
4747
//|
4848
//| When we're the server, we ignore all connections besides the first to subscribe to
@@ -97,7 +97,7 @@ STATIC void check_for_deinit(bleio_packet_buffer_obj_t *self) {
9797
//| .. method:: readinto(buf)
9898
//|
9999
//| Reads a single BLE packet into the ``buf``. Raises an exception if the next packet is longer
100-
//| than the given buffer. Use `incoming_packet_length` to read the maximum length of a single packet.
100+
//| than the given buffer. Use `packet_size` to read the maximum length of a single packet.
101101
//|
102102
//| :return: number of bytes read and stored into ``buf``
103103
//| :rtype: int
@@ -171,7 +171,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_1(bleio_packet_buffer_deinit_obj, bleio_packet_bu
171171
//| Maximum size of a packet.
172172
//| If the packet is arriving from a remote service via notify or indicate,
173173
//| the maximum size is `Connection.max_packet_length`.
174-
//| Otherwise it is the ``max_length`` of the `Characteristic`.
174+
//| Otherwise it is the ``max_length`` of the :py:class:`~_bleio.Characteristic`.
175175
//|
176176
STATIC mp_obj_t bleio_packet_buffer_get_packet_size(mp_obj_t self_in) {
177177
bleio_packet_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);

0 commit comments

Comments
 (0)