Merge pull request #1815 from a-andre/doc

Fix function name in documentation
private-octopus · Jan 7, 2025 · 7a88998 · 7a88998
2 parents f778ff0 + 0d1e7f7
commit 7a88998
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc/send_receive_data.md b/doc/send_receive_data.md
@@ -281,7 +281,7 @@ in an error `PICOQUIC_ERROR_DATAGRAM_TOO_LONG`.
 With the just in time API, the application:
 
 - indicates its readiness to send datagrams marks a stream as `active` using
-  the API `picoquic_set_datagram_ready`.
+  the API `picoquic_mark_datagram_ready`.
 
 - receives the callback `picoquic_callback_prepare_datagram` when the stack is ready
 to send datagrams in a packet.

diff --git a/picoquic/picoquic.h b/picoquic/picoquic.h
@@ -1334,7 +1334,7 @@ int picoquic_stop_sending(picoquic_cnx_t* cnx,
  * of the stream to NULL */
 int picoquic_discard_stream(picoquic_cnx_t* cnx, uint64_t stream_id, uint16_t local_stream_error);
 
-/* The function picoquic_set_datagram_ready indicates to the stack
+/* The function picoquic_mark_datagram_ready indicates to the stack
  * whether the application is ready to send datagrams. 
  * 
  * When running in a multipath environment, some applications may want to