Unclear return type specification of `cpus()` in `OS.md`
- Dominant language
- JavaScript
- Stars
- 20
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/AdobeDocs/uxp/blob/47510097aaf62876dfe00a01e00461ce5018e6cc/src/pages/uxp/reference-js/Modules/os/OS.md?plain=1#L34-L41
It isn't clear what kind of information is in the array. Even if we don't have a perfect type definition, specifiying that this is an `Array` (or maybe `Array`) already increases the understanding that one can get just from reading/scanning this).
Contributor guide
Research direction
Open src/pages/uxp/reference-js/Modules/os/OS.md and inspect the cpus() documentation around lines 34–41. Clarify the return type so the array contents are understandable, using the issue’s suggested Array or Array as appropriate. Done means the documented return type clearly communicates what the array contains.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100