Example sketch TickerParameter.ino implementation doesn't match its comments

Open Beginner friendly
#9,203 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
arduino, cpp
Domain
embedded-iot

Research direction

Start with libraries/Ticker/examples/TickerParameter/TickerParameter.ino and compare its three Ticker instances with the introductory comment. Confirm the intended two-ticker example and different callback arguments, then verify that the implementation and comments agree.

Written by the indexing model from the issue text.

Description

Basic Infos
  • This issue complies with the issue POLICY doc.
  • I have read the documentation at readthedocs and the issue is not addressed there.
  • I have tested that the issue is present in current master branch (aka latest git).
  • I have searched the issue tracker for a similar issue.
  • If there is a stack dump, I have decoded it.
  • I have filled out all fields below.
Platform

n/a

Settings in IDE

n/a

Problem Description

The example sketch TickerParameter.ino

says in comment:

This sample runs two tickers that both call one callback function, but with different arguments.

However, implementations used three Ticker instances. A callback function with a parameter is used on one of them but always with same parameter. I suspect this example may have been left in a work-in-progress state and never completed.

Dominant language
C++
Stars
16.7k
Forks
13.1k
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from esp8266/Arduino

All issues in esp8266/Arduino

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.