Blockstream / Blockstream/Jade
`register_descriptor` docs have incorrect type for `datavalues`
Open
Beginner friendly
- Dominant language
- C
- Stars
- 496
- Forks
- 127
- PR merge metrics
- No merged PRs in 30d
Description
The example in the docs for `register_descriptor` suggests that `datavalues` is an array of dicts, when the actual type is a dict. This confused me for a while when working on descriptor registration for HWI.
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the documentation example for register_descriptor and review how datavalues is described. Correct the example so datavalues is shown as a dict rather than an array of dicts, then verify the documented type matches the API used for descriptor registration in HWI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100