Where can I find the definition of the set_timer_1hz function?

Open
#328 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start with the book's concurrency section, where set_timer_1hz is used. Find the definition or a suitable timer setup example, then update the section to link to it or include the needed explanation; the documentation should make the function's origin and timer setup clear.

Written by the indexing model from the issue text.

Description

Hey there 👋

I was looking through the concurrency section and noticed the set_timer_1hz function being used there to setup a timer. I am guessing that this function just abstracts away some boilerplate to setup the timer, that would otherwise bloat the documentation. However, I have not found any piece of code in the book, that shows how to set such a timer up. Would it be an idea to eather point to such an example, or provide the definition in the in the concurrency section?

Dominant language
No language data
Stars
1.3k
Forks
223
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 rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.