🐛 needs.json: a number field's integer default (and an imported int) is written as an int, and every declared field carries a description — ubCode writes floats and no description
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 20/100
Research direction
Start with the needs.json schema block and how number fields serialize their default, plus the hash texts for the same values. The payload names the ub-needs-exchange package as the place to state the float-versus-int contract, but the issue leaves open which tool changes, so a newcomer needs a maintainer decision before editing. Done means the agreed contract is written down and both sides produce the same values, with description handling settled too.
Written by the indexing model from the issue text.
Description
What
A number field's integer default is written as the int it was declared with — the needs.json schema block says "default": 0, a need holds 0, hash texts [0] — and an imported number value written as 42 stays 42; a number field in ubCode holds floats by its type (0.0, 42.0), so the two tools' needs.json files and hash texts for the same project differ in these cells while the numbers are equal (the derived-values contract's A-36 class; measured on 8b7a4658 by the derive_by_type recon, probes p2, p11, p15a, p21). sphinx-needs also writes "description": "Added by needs_fields config" into every declared field's schema block, which ubCode does not.
ubCode's side is useblocks/ubcode#4071; which side moves is open.
Do
Decide the contract (coerce to float at the field boundary, as the schema type says, or keep Python's int), then mirror; the exchange package (ub-needs-exchange) is the natural place to state it.
- Dominant language
- Python
- Stars
- 309
- Forks
- 103
- Avg merge
- 11h 26m
- Merged PRs (30d)
- 118
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 useblocks/sphinx-needs
-
documentation pkg: sphinx-needs
Difficulty 1/5 Under an hour Newbie friendliness 82/100
useblocks/sphinx-needs#2255 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
useblocks/sphinx-needs#2253 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
useblocks/sphinx-needs#2251 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
useblocks/sphinx-needs#2249 ·
Maintainers usually reply within 1 day
-
documentation pkg: sphinx-test-reports
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
useblocks/sphinx-needs#2247 ·
Maintainers usually reply within 1 day
All issues in useblocks/sphinx-needs
Similar issues
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
btclib-org/btclib-node#1955 ·
Maintainers usually reply within 1 day
-
documentation v0.9.2
Difficulty 2/5 Half a day Newbie friendliness 72/100
khuisman/mcp-gee-sweet#1033 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ossf/cve-bin-tool#5966 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 2 days
-
write_iceberg ignores the table's write.parquet.compression-codec propertyPossibly taken @YuangGao claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Eventual-Inc/Daft#7606 ·
Maintainers usually reply within 1 day