Skip to content
Snippets Groups Projects
Select Git revision
  • ed9c0185d80514670244b0c2147958dea00159a9
  • master default protected
2 results

machine.Timer.rst

  • Damien George's avatar
    d8e03204
    docs: Move WiPy specific Timer class to separate doc file. · d8e03204
    Damien George authored
    The WiPy machine.Timer class is very different to the esp8266 and esp32
    implementations which are better candidates for a general Timer class.  By
    moving the WiPy Timer docs to a completely separate file, under a new name
    machine.TimerWiPy, it gives a clean slate to define and write the docs for
    a better, general machine.Timer class.  This is with the aim of eventually
    providing documentation that does not have conditional parts to it,
    conditional on the port.
    
    While the new docs are being defined it makes sense to keep the WiPy docs,
    since they describe its behaviour.  Once the new Timer behaviour is defined
    the WiPy code can be changed to match it, and then the TimerWiPy docs would
    be removed.
    d8e03204
    History
    docs: Move WiPy specific Timer class to separate doc file.
    Damien George authored
    The WiPy machine.Timer class is very different to the esp8266 and esp32
    implementations which are better candidates for a general Timer class.  By
    moving the WiPy Timer docs to a completely separate file, under a new name
    machine.TimerWiPy, it gives a clean slate to define and write the docs for
    a better, general machine.Timer class.  This is with the aim of eventually
    providing documentation that does not have conditional parts to it,
    conditional on the port.
    
    While the new docs are being defined it makes sense to keep the WiPy docs,
    since they describe its behaviour.  Once the new Timer behaviour is defined
    the WiPy code can be changed to match it, and then the TimerWiPy docs would
    be removed.