Skip to content

Document JsonDocCk and checkmissingitems.py #100515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
aDotInTheVoid opened this issue Aug 14, 2022 · 0 comments
Open

Document JsonDocCk and checkmissingitems.py #100515

aDotInTheVoid opened this issue Aug 14, 2022 · 0 comments
Assignees
@aDotInTheVoid
Labels
A-contributor-roadblock Area: Makes things more difficult for new or seasoned contributors to Rust A-rustdoc-json Area: Rustdoc JSON backend T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@aDotInTheVoid
Copy link
Member

aDotInTheVoid commented Aug 14, 2022 •
edited
Loading

The testing infra for rustdoc-json isn't well documented.

It would be good to write down how it works, as well as some tips for developing tests.

Things to documents

  • jsondocck commands
  • JSONPath usage
  • Variables
  • Semantics of jsonpath multiple selections, and when to use [*]
  • no_core for smaller output
  • selecting on doc to simplify queries.
  • my oj format script
  • only rerunning jsondocck (not x.py)
  • Modifying checkmissingitems.py after changing schema

@rustbot claim

@rustbot modify labels: +A-rustdoc-json +T-rustdoc +A-contributor-roadblock
@rustbot rustbot added A-contributor-roadblock Area: Makes things more difficult for new or seasoned contributors to Rust A-rustdoc-json Area: Rustdoc JSON backend T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 14, 2022
@aDotInTheVoid aDotInTheVoid mentioned this issue Apr 14, 2023
Merged
jyn514 added a commit to jyn514/rust that referenced this issue Apr 26, 2023
@jyn514
Rollup merge of rust-lang#110329 - aDotInTheVoid:json-inline-again, r…
a1d4718 
…=jyn514

Improve tests for rust-lang#110138

These should live in rustdoc-json, not rustdoc-ui, so we can run assertions, and not just check there's no ICE

CC rust-lang#100515, as we never document this suite

r? rustdoc
@GuillaumeGomez GuillaumeGomez mentioned this issue Jan 19, 2023
Open
13 tasks
@aDotInTheVoid aDotInTheVoid mentioned this issue Mar 21, 2025
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 21, 2025
@matthiaskrgr
Rollup merge of rust-lang#138763 - aDotInTheVoid:two-years-later, r=G…
51ccfa2 
…uillaumeGomez

jsondocck: Replace `jsonpath_lib` with `jsonpath-rust`

The current jsonpath implementation we use isn't spec-compliant, and is buggy. See freestrings/jsonpath#91

To solve it, it's replaced with https://github.com/besok/jsonpath-rust. This is spec-compiant, and doesn't have a really awkward bug we need to always dance around.

Unfortunately, this requires rewriting almost every test, as the behaviour of `[?(`@`,` which is *extremely* common was changed. (But the new behaviour makes way more sense, and isn't buggy with tripply nested selectors)

Unblocks rust-lang#110406. Makes rust-lang#100515 much easier as we don't need to explain the broken JSONPath implementation

Best reviewed commit-by-commit. The first does the replacement. The next two rewrite the test-suite mechanically. The last rewrites the test-suite by hand.

r? `@GuillaumeGomez`
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 21, 2025
@matthiaskrgr
Rollup merge of rust-lang#138763 - aDotInTheVoid:two-years-later, r=G…
66d2e2a 
…uillaumeGomez

jsondocck: Replace `jsonpath_lib` with `jsonpath-rust`

The current jsonpath implementation we use isn't spec-compliant, and is buggy. See freestrings/jsonpath#91

To solve it, it's replaced with https://github.com/besok/jsonpath-rust. This is spec-compiant, and doesn't have a really awkward bug we need to always dance around.

Unfortunately, this requires rewriting almost every test, as the behaviour of `[?(``@`,`` which is *extremely* common was changed. (But the new behaviour makes way more sense, and isn't buggy with tripply nested selectors)

Unblocks rust-lang#110406. Makes rust-lang#100515 much easier as we don't need to explain the broken JSONPath implementation

Best reviewed commit-by-commit. The first does the replacement. The next two rewrite the test-suite mechanically. The last rewrites the test-suite by hand.

r? ``@GuillaumeGomez``
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 22, 2025
@matthiaskrgr
Rollup merge of rust-lang#138763 - aDotInTheVoid:two-years-later, r=G…
a4c0173 
…uillaumeGomez

jsondocck: Replace `jsonpath_lib` with `jsonpath-rust`

The current jsonpath implementation we use isn't spec-compliant, and is buggy. See freestrings/jsonpath#91

To solve it, it's replaced with https://github.com/besok/jsonpath-rust. This is spec-compiant, and doesn't have a really awkward bug we need to always dance around.

Unfortunately, this requires rewriting almost every test, as the behaviour of `[?(```@`,``` which is *extremely* common was changed. (But the new behaviour makes way more sense, and isn't buggy with tripply nested selectors)

Unblocks rust-lang#110406. Makes rust-lang#100515 much easier as we don't need to explain the broken JSONPath implementation

Best reviewed commit-by-commit. The first does the replacement. The next two rewrite the test-suite mechanically. The last rewrites the test-suite by hand.

r? ```@GuillaumeGomez```
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Mar 22, 2025
@rust-timer
Unrolled build for rust-lang#138763
ad02445 
Rollup merge of rust-lang#138763 - aDotInTheVoid:two-years-later, r=GuillaumeGomez

jsondocck: Replace `jsonpath_lib` with `jsonpath-rust`

The current jsonpath implementation we use isn't spec-compliant, and is buggy. See freestrings/jsonpath#91

To solve it, it's replaced with https://github.com/besok/jsonpath-rust. This is spec-compiant, and doesn't have a really awkward bug we need to always dance around.

Unfortunately, this requires rewriting almost every test, as the behaviour of `[?(```@`,``` which is *extremely* common was changed. (But the new behaviour makes way more sense, and isn't buggy with tripply nested selectors)

Unblocks rust-lang#110406. Makes rust-lang#100515 much easier as we don't need to explain the broken JSONPath implementation

Best reviewed commit-by-commit. The first does the replacement. The next two rewrite the test-suite mechanically. The last rewrites the test-suite by hand.

r? ```@GuillaumeGomez```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aDotInTheVoid aDotInTheVoid

Labels
A-contributor-roadblock Area: Makes things more difficult for new or seasoned contributors to Rust A-rustdoc-json Area: Rustdoc JSON backend T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@aDotInTheVoid @rustbot