🔧 ub-needs-exchange: the JSON path form of a finding — dotted today, root[...] in ubCode — decide before ubCode vendors
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 15/100
Research direction
Start with Diagnostic.path in ub-needs-exchange and the sphinx-needs warnings for needs.needimport and needs.external_needs, which print the path as (at <path>). The reference form is render_json_path in rust/ubc_needs/src/json_path.rs, which lives in the ubCode repo. The work is a maintainer decision on the path form, not a code change to make yet. Done means a chosen form, a changelog line on the sphinx-needs side, and a corpus re-vendor plan.
Written by the indexing model from the issue text.
Description
Diagnostic.path in ub-needs-exchange is the reader's dotted form (versions.1.0.needs.A.id), kept in 1.0.0 because the first slice changed no behaviour and sphinx-needs prints (at <path>) in its needs.needimport / needs.external_needs warnings. It is ambiguous for a version name or an id holding a ., and ubCode's house form for a JSON path is root['versions']['1.0'] (rust/ubc_needs/src/json_path.rs, render_json_path).
Choosing one form is a contract change (the corpus compares findings as code + path) AND a sphinx-needs warning-text change, so it needs a changelog line on the sphinx-needs side and a corpus re-vendor on ubCode's. Decide before ubCode vendors the document layer (useblocks/ubcode's vendoring issue references this one).
From the ub-needs-exchange 1.0.0 build (#2219, follow-up F1).
- 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
-
md/asciidoc/csv: an explicit `encoding="utf-8"` keeps a leading BOM, the auto-detect path drops itOpen
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
docling-project/docling#4846 ·
Maintainers usually reply within 1 day
-
area/sessions comp/dashboard comp/desktop comp/gateway comp/tui duplicate P2 sweeper:risk-session-state type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
NousResearch/hermes-agent#138914 · 1 comment ·
Maintainers usually reply within 1 day
-
bot-triaged module: activation checkpointing module: inductor oncall: pt2 triaged
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
[oblt-aw][autodoc] Update PR Actions Detective E2E prerequisites and fix dashboard-format table typoOpendocumentation
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/oblt-aw#2382 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day