i2c: timeout error code not specified
Open
- Dominant language
- C
- Stars
- 891
- Forks
- 381
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 14
Description
Documentation doesn't specify the value of the error code returned in case of timeout in `hal_i2c_master_read` or `hal_i2c_master_write`
Contributor guide
No contributing guide indexed for this repository
Research direction
Search for the documentation and implementations of hal_i2c_master_read and hal_i2c_master_write, then inspect their timeout return paths to identify the error code. Update the relevant documentation to state that code for both functions and verify the documented value matches the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100