Skip to content

Document JsonDocCk and checkmissingitems.py #100515

Open
rust-lang/rustc-dev-guide
#2422
@aDotInTheVoid

Description

@aDotInTheVoid

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

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