`register_descriptor` docs have incorrect type for `datavalues`
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- c
- Domain
- documentation
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.
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.
- Dominant language
- C
- Stars
- 497
- Forks
- 131
- PR merge metrics
- No merged PRs in 30d
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.
More from Blockstream/Jade
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Blockstream/Jade#329 · 4 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Blockstream/Jade#315 · 3 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Blockstream/Jade#313 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Blockstream/Jade#345 · 4 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Blockstream/Jade#344 · 1 comment ·
All issues in Blockstream/Jade
Similar issues
-
level/task module/gcp type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
docs
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
P3 sonic-vpp
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sonic-net/sonic-buildimage#29662 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
spack/spack-packages#6586 ·
-
category:port-update
Difficulty 2/5 1-3 hours Newbie friendliness 72/100