rust-embedded / rust-embedded/cortex-m
Use `#[doc(cfg(...))]`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1k
- Forks
- 202
- Avg merge
- 6d 2h
- Merged PRs (30d)
- 2
Description
A lot of our API is behind #[cfg]. Currently, that fact is only sometimes indicated in the documentation, which makes it hard to figure out, but as it turns out rustdoc has a feature for that: #[doc(cfg(<...>))].
This can be used to decorate types and method with information about their availability. An example of this can be seen in the async-std docs, which marks some APIs as unstable.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing the crate's public APIs currently guarded by #[cfg] and compare their documentation with the async-std example linked in the issue. Done means the relevant conditional APIs consistently expose their availability through #[doc(cfg(...))] annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100