Documentation: expand explanations about "alarms"
Open
Nobody has claimed this yet.
part: documentation
- Dominant language
- Python
- Stars
- 441
- Forks
- 90
- Avg merge
- 1d 12m
- Merged PRs (30d)
- 5
Description
Alarms are mentioned and used several times in the documentation pages. We could have a dedicated section explaining why they are useful, how to use them and other relevant details.
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
No documentation file or test is named. Find the existing documentation pages that mention alarms, then define a dedicated section covering why alarms are useful, how to use them, and other relevant details; done means those explanations are added and the documentation remains consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100