Double space in async trait docs generated by decl_threshold_traits!
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 85/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- rust
- Domain
- embedded-iot
Research direction
Open embedded-sensors/src/sensor.rs and inspect the blocking and async arms of decl_threshold_traits!. Start by comparing their doc_suffix values. Done means the async-generated trait documentation renders with a single space, with the related human-readable sensor-name improvement considered separately.
Written by the indexing model from the issue text.
Description
Problem
In embedded-sensors/src/sensor.rs, the blocking arm passes doc_suffix = "synchronously" while the async arm passes doc_suffix = " asynchronously" - with a leading space. The surrounding concat! already inserts the separating space, so every async-generated trait doc renders with a double space:
Set Temperature thresholds asynchronously.
Suggested fix
Drop the leading space from the async doc_suffix.
Related nit (same code path)
stringify!($SensorName) produces the un-spaced identifier, so docs read "Set RelativeHumidity thresholds ..." rather than "Set relative humidity thresholds ...". Consider threading a separate human-readable $display_name string literal through the macro alongside $unit.
- Dominant language
- Rust
- Stars
- 4
- Forks
- 9
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenDevicePartnership/embedded-sensors
-
documentation
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
enhancement good first issue
Difficulty 4/5 3-5 days Newbie friendliness 52/100
-
enhancement rust
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
documentation rust
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
enhancement rust
Difficulty 5/5 Over a week Newbie friendliness 35/100
All issues in OpenDevicePartnership/embedded-sensors
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
gitbutlerapp/gitbutler#15998 · 1 comment ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100