Skip to content

Document JsonDocCk and checkmissingitems.py #100515

New issue
New issue
Closed
rust-lang/rustc-dev-guide
#2422
Closed
Document JsonDocCk and checkmissingitems.py#100515
rust-lang/rustc-dev-guide
#2422
Assignees
aDotInTheVoid
Labels
A-contributor-roadblockArea: Makes things more difficult for new or seasoned contributors to RustA-rustdoc-jsonArea: Rustdoc JSON backendT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Description

@aDotInTheVoid
aDotInTheVoid
opened on Aug 14, 2022

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

Activity

  1. Imagerustbot
    assigned
    aDotInTheVoid
    on Aug 14, 2022
  2. Imagerustbot
    added
    A-contributor-roadblockArea: Makes things more difficult for new or seasoned contributors to Rust
    A-rustdoc-jsonArea: Rustdoc JSON backend
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Aug 14, 2022
  3. Imagejyn514
    added a commit that references this issue on Apr 26, 2023

    Rollup merge of rust-lang#110329 - aDotInTheVoid:json-inline-again, r…

    a1d4718
  4. Imagematthiaskrgr
    added 3 commits that reference this issue on Mar 21, 2025

    Rollup merge of rust-lang#138763 - aDotInTheVoid:two-years-later, r=G…

    51ccfa2

    Rollup merge of rust-lang#138763 - aDotInTheVoid:two-years-later, r=G…

    66d2e2a

    Rollup merge of rust-lang#138763 - aDotInTheVoid:two-years-later, r=G…

    a4c0173
  5. Imagerust-timer
    added a commit that references this issue on Mar 22, 2025

    Unrolled build for rust-lang#138763

    ad02445

  6. aDotInTheVoid commented on May 28, 2025

    @aDotInTheVoid
    aDotInTheVoid
    on May 28, 2025
    MemberAuthor

    I have a draft open for this as rust-lang/rustc-dev-guide#2422

  7. ImageaDotInTheVoid
    closed this as completedin rustc-dev-guide#2422on Sep 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-contributor-roadblockArea: Makes things more difficult for new or seasoned contributors to RustA-rustdoc-jsonArea: Rustdoc JSON backendT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions