particle-iot / particle-iot/docs
Document System.enableReset et al
Open
Nobody has claimed this yet.
firmware
- Dominant language
- JavaScript
- Stars
- 148
- Forks
- 266
- Avg merge
- 14h 41m
- Merged PRs (30d)
- 16
Description
These system methods are currently not documented:
enableReset()
disableReset()
resetEnabled()
resetPending()
The reset_pending system event mentions enableReset() but there's no other mention
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
Find the documentation entry for the reset_pending system event and inspect its reference to enableReset(). Then locate the relevant system-method documentation area and document enableReset(), disableReset(), resetEnabled(), and resetPending(); done means all four methods are described and the existing event reference is 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
- Mostly clear
- Newbie friendliness
- 45/100