docs/library/network.PPP: Document the optional poll() argument.

projectgus · dpgeorge · commit 115f4134aae7 · 2026-02-07T01:13:19.000+11:00
This argument isn't expected to be passed from Python code, but - as
pointed out - it doesn't make sense how the irq() mechanism works
otherwise.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton &lt;angus@redyak.com.au&gt;
diff --git a/docs/library/network.PPP.rst b/docs/library/network.PPP.rst
@@ -90,12 +90,15 @@ Methods
 
    See `AbstractNIC.ifconfig`.
 
-.. method:: PPP.poll()
+.. method:: PPP.poll([irq_arg])
 
    Poll the underlying stream for data, and pass it up the PPP stack.
    This is called automatically if the stream is a UART with a RXIDLE interrupt,
    so it's not usually necessary to call it manually.
 
+   The optional *irq_arg* argument is ignored, this argument exists only so this
+   function is compatible with the :func:`machine.UART.irq` *handler* argument.
+
 Constants
 ---------
 
