`TIMER` documentation needs updating #290

New issue

Closed

opened 2026-02-20 10:16:08 -05:00 by deekerman · 3 comments

deekerman commented

2026-02-20 10:16:08 -05:00

Owner

Originally created by @rogerl50 on GitHub (Jun 23, 2021).

Originally assigned to: @RaphaelAlvez on GitHub.

There is no documentation for the TIMER function. Also, timers don't appear in the Widget Guide text, nor is there any explanation of their function in the Widget Properties section. Finally, the toggle property (at least) is missing from the Widget Properties. I'd fix all this myself, but I don't really understand yet how timers work.

Originally created by @rogerl50 on GitHub (Jun 23, 2021). Originally assigned to: @RaphaelAlvez on GitHub. There is no documentation for the `TIMER` function. Also, timers don't appear in the Widget Guide text, nor is there any explanation of their function in the Widget Properties section. Finally, the `toggle` property (at least) is missing from the Widget Properties. I'd fix all this myself, but I don't really understand yet how timers work.

deekerman

2026-02-20 10:16:08 -05:00

closed this issue
added the
documentation
label

deekerman commented

2026-02-20 10:16:09 -05:00

Author

Owner

@96LawDawg commented on GitHub (Jun 23, 2021):

Half of the things in the Widget Properties section do not have any elaborating detail (spinners, labels, etc.). And the Widget Guide section also does not cover everything and that is probably the least updated page on the wiki. Those are not necessarily a good thing. Just an observation.

Regarding toggle I don't think that is a property (maybe I'm wrong?!?). It is a mode option when using a timer FUNCTION. And that is not documented. I pointed this out in the wiki channel on 6/15: "On the Functions Overview page, the functions listed line up with what is available in JSON editor with two exceptions. Missing are "CANVAS" and "TIMER." Those don't behave like normal functions because they are actually linked to composed widget types. However, just pointing out the inconsistency. Not sure what, if anything, can or should be done about that." Some documentation there would probably be a good idea.

@96LawDawg commented on GitHub (Jun 23, 2021): Half of the things in the Widget Properties section do not have any elaborating detail (spinners, labels, etc.). And the Widget Guide section also does not cover everything and that is probably the least updated page on the wiki. Those are not necessarily a good thing. Just an observation. Regarding `toggle` I don't think that is a property (maybe I'm wrong?!?). It is a mode option when using a timer FUNCTION. And that is not documented. I pointed this out in the wiki channel on 6/15: "On the Functions Overview page, the functions listed line up with what is available in JSON editor with two exceptions. Missing are "CANVAS" and "TIMER." Those don't behave like normal functions because they are actually linked to composed widget types. However, just pointing out the inconsistency. Not sure what, if anything, can or should be done about that." Some documentation there would probably be a good idea.

deekerman commented

2026-02-20 10:16:09 -05:00

Author

Owner

@RaphaelAlvez commented on GitHub (Jun 23, 2021):

Toggle is a mode of the TIMER function.

@96LawDawg the CANVAS and the TIMER functions are related to the canvas and timer widgets. Not the composed widget. They are used in the composed widgets and created having those in mind. But yeah I agree they are a bit different.

@RaphaelAlvez commented on GitHub (Jun 23, 2021): Toggle is a mode of the TIMER function. @96LawDawg the CANVAS and the TIMER functions are related to the canvas and timer widgets. Not the composed widget. They are used in the composed widgets and created having those in mind. But yeah I agree they are a bit different.

deekerman commented

2026-02-20 10:16:09 -05:00

Author

Owner

@rogerl50 commented on GitHub (Jul 12, 2021):

Documentation for CANVAS and TIMER were added.

@rogerl50 commented on GitHub (Jul 12, 2021): Documentation for CANVAS and TIMER were added.