Repository navigation
docs: Pin.toggle() method is not documented #9652
Description
Activity
- changed the title
[-]docs: Pin.off() method is not documented[/-][+]docs: Pin.toggle() method is not documented[/+]on Oct 17, 2022 It's available only at the rp2 and samd port, as you know. It is more frequently found as part of the machine.LED class, which b.t.w. is not documented at all. The pyb.LED class is.
Already opened a PR at #9653, sorry 😅
I really think board ports should be more harmonized for basic fonctions, otherwise we lost the theorical advantage of uPython : one code that works on different hardware ...
You're right. But then the discussion starts again about what is a basic function. The Pin class has quite a few methods which could for instance be considered as not basic, like
pin.toggle(),pin.on(),pin.off(). The latter two are actually misleading, because a pin cannot be on or off. And toggle can always be written e.g. aspin(not pin()).
Ports and boards have different resources, like flash and RAM. Devices with a small flash will always provide only a subset of both the language features and hardware support.Reacted by Stewart RussellI do not consider toggle to be core. It is trivial to use
pin.value(not pin.value()). Proposing to close.I do not consider toggle to be core. It is trivial to use
pin.value(not pin.value()). Proposing to close.I agree, but I think we at least should document it on the ports where it's already implemented.
Pin.toggle()method works (at least for RP2040 platform) but it is not documented here:https://docs.micropython.org/en/latest/library/machine.Pin.html#methods