rust-embedded / rust-embedded/heapless

Should examples be marked as no_run instead of ignore?

Open
#270 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Rust
Stars
2k
Forks
253
Avg merge
1d 2h
Merged PRs (30d)
1

Description

Coming out of #269 , I'm wondering if it makes sense to change all examples from ignore to just no_run. This would ensure they all still compile. I can take a look at this, but wanted to file a radar so I don't forget / if I forget at least I wrote it down 😅

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.

Research direction

Start by reading issue #269 and locating the repository examples currently marked with ignore. Check how Rust treats ignore versus no_run, then update the relevant example annotations so the examples remain compilable while not being executed; verify the full example or documentation checks pass.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.