Skip to content

rustdoc: Tracking issue for heavily increasing the JSON test coverage #81359

Open
Open
rustdoc: Tracking issue for heavily increasing the JSON test coverage#81359
Labels
A-rustdoc-jsonArea: Rustdoc JSON backendA-testsuiteArea: The testsuite used to check the correctness of rustcC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Description

@CraftSpider
CraftSpider
opened on Jan 24, 2021

Currently, the output of rustdoc's JSON backend has very few tests, which only assure some of the most simple functionality. It would be nice to at least have tests for basic forms of each item, as well as any known issues. A quick list of things not really tested (non-exhaustive):

  • Impls
  • Associated Items
  • Consts/Statics
  • Extern items (all forms)
  • Macros
  • Types

It also would be nice to know the desired layout of the tests. Currently, the directory holds the form

root
| structs
- | plain
  | tuple
  | generic
| traits
- | has_body
| unions
- | plain
| ...

This is slightly different from how normal rustdoc ui tests are structured, but on the other hand HTML output is very different and serves a somewhat different goal. If we want to establish guidelines on the test directory layout, now is a good time to discuss it, before the directories fill up.

Activity

  1. CraftSpider
    added
    C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFC
    on Jan 24, 2021
  2. jyn514
    added
    A-rustdoc-jsonArea: Rustdoc JSON backend
    A-testsuiteArea: The testsuite used to check the correctness of rustc
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Jan 24, 2021
  3. JohnTitor
    added 3 commits that reference this issue on Mar 11, 2021

    Rollup merge of rust-lang#82571 - aDotInTheVoid:reexport-tests, r=Cra…

    56fee40

    Rollup merge of rust-lang#82571 - aDotInTheVoid:reexport-tests, r=Cra…

    c63a963

    Rollup merge of rust-lang#82571 - aDotInTheVoid:reexport-tests, r=Cra…

    a98dc9b
  4. Manishearth
    added
    A-rustdoc
    and removed
    A-rustdoc
    on Apr 23, 2021
  5. matthiaskrgr
    added 3 commits that reference this issue on Feb 11, 2022

    Rollup merge of rust-lang#93660 - aDotInTheVoid:rustdoc-type-tests, r…

    985e34e

    Rollup merge of rust-lang#93660 - aDotInTheVoid:rustdoc-type-tests, r…

    50a7e68

    Rollup merge of rust-lang#93660 - aDotInTheVoid:rustdoc-type-tests, r…

    ffa8d6b
  6. matthiaskrgr
    added a commit that references this issue on Mar 15, 2022

    Rollup merge of rust-lang#94861 - aDotInTheVoid:rdj-trait-tests, r=Cr…

    918888f

  7. 14 remaining items

  8. workingjubilee
    added 4 commits that reference this issue on Aug 30, 2024

    Rollup merge of rust-lang#129123 - aDotInTheVoid:rustdoc-json-self, r…

    4b9e608

    Rollup merge of rust-lang#129123 - aDotInTheVoid:rustdoc-json-self, r…

    e411e44

    Rollup merge of rust-lang#129123 - aDotInTheVoid:rustdoc-json-self, r…

    c3b1336

    Rollup merge of rust-lang#129123 - aDotInTheVoid:rustdoc-json-self, r…

    303116f
  9. matthiaskrgr
    added 2 commits that reference this issue on Aug 31, 2024

    Rollup merge of rust-lang#129123 - aDotInTheVoid:rustdoc-json-self, r…

    e8f19ac

    Rollup merge of rust-lang#129123 - aDotInTheVoid:rustdoc-json-self, r…

    defc245
  10. rust-timer
    added a commit that references this issue on Aug 31, 2024

    Unrolled build for rust-lang#129123

    52b51b8
  11. GuillaumeGomez
    added a commit that references this issue on Dec 2, 2024

    Rollup merge of rust-lang#133721 - aDotInTheVoid:rdj-dyn-link, r=Guil…

    7fdbde0
  12. rust-timer
    added a commit that references this issue on Dec 2, 2024

    Unrolled build for rust-lang#133721

    c4a363d
  13. jhpratt
    added a commit that references this issue on Mar 8, 2025

    Rollup merge of rust-lang#138033 - obi1kenobi:pg/json-attrs-tests, r=…

    a29e3af
  14. rust-timer
    added a commit that references this issue on Mar 8, 2025

    Unrolled build for rust-lang#138033

    a7ef12b
  15. jhpratt
    added 2 commits that reference this issue on Mar 18, 2025

    Rollup merge of rust-lang#138569 - aDotInTheVoid:reprdoc-json, r=Guil…

    560b40d

    Rollup merge of rust-lang#138569 - aDotInTheVoid:reprdoc-json, r=Guil…

    7872c53
  16. matthiaskrgr
    added a commit that references this issue on Mar 18, 2025

    Rollup merge of rust-lang#138569 - aDotInTheVoid:reprdoc-json, r=Guil…

    bf98654
  17. fmease
    changed the title [-][rustdoc-json] Output is currently under-tested[/-] [+]rustdoc: Tracking issue for heavily increasing the JSON test coverage[/+] on Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-rustdoc-jsonArea: Rustdoc JSON backendA-testsuiteArea: The testsuite used to check the correctness of rustcC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCT-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