ESPNow.send argument types / @overloads

[Josverl]

@glenn20 , I hopy you can assist in improvin the type-stubs for this.

I am in process of adding parameter types to the type-stubs, and I use the examples from the documentation to help verify the level of correctness of the stubs.

#espnow.pyi 

_MACAddress: TypeAlias = bytes
_PeerInfo: TypeAlias = Tuple[_MACAddress, bytes, int, int, bool]

class ESPNow(ESPNowBase, Iterator):
    #....
    def send(
        self,
        peer: _MACAddress,
        msg: str | bytes,
        mac: _MACAddress | None = None,
        sync: bool = True,
    ) -> bool:
        """Send the data contained in ``msg`` to the peer with given network ``mac`` address."""
   ...

If I check this with the Sender: example on https://docs.micropython.org/en/latest/library/espnow.html#module-espnow
then both pyright and mypy report an error on the e.send in:

for i in range(100):
    e.send(peer, str(i) * 20, True)

• pyright: error: Argument of type "Literal[True]" cannot be assigned to parameter "mac" of type "_MACAddress | None" in function "send"
• mypy: error: Argument 3 to "send" of "ESPNow" has incompatible type "bool"; expected "bytes | None" [arg-type]

before digging deeper I wanted to check if I have understood the documentation correctly, this is a documentation bug, or that this is a form that the typecheckers cannot handle by default.

Code sample in pyright playground