jsondocck: Parse, don't validate commands. by aDotInTheVoid · Pull Request #133478 · rust-lang/rust (original) (raw)

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.

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

Already on GitHub?Sign in to your account

Conversation19 Commits1 Checks6 Files changed

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

aDotInTheVoid

Centralizes knowledge of jsondocck syntax into the parser, so the checker doesn't need to know what the indexes are.

Vaguely related zulip discussion

I'm very happy this is negative LoC, despite adding a big, documented enum!

r? @fmease

jieyouxu

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question (I'm not a rustdoc reviewer): does this have any tests?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, no self tests yet for either JsonDocCk or HtmlDocCk. That's a long term plan of mine though (next to documenting their directives in the rustc-dev-guide (which should happen much sooner 🤞)).

fmease

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this! I have some suggestions but otherwise looks good :)

@fmease fmease added S-waiting-on-author

Status: This is awaiting some action (such as code changes or more information) from the author.

and removed S-waiting-on-review

Status: Awaiting review from the assignee but also interested parties.

labels

Dec 7, 2024

@aDotInTheVoid

@aDotInTheVoid

@rustbot rustbot added S-waiting-on-review

Status: Awaiting review from the assignee but also interested parties.

and removed S-waiting-on-author

Status: This is awaiting some action (such as code changes or more information) from the author.

labels

Dec 9, 2024

fmease

@fmease

@bors

📌 Commit e6bc427 has been approved by fmease

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors

Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

and removed S-waiting-on-review

Status: Awaiting review from the assignee but also interested parties.

labels

Dec 9, 2024

fmease added a commit to fmease/rust that referenced this pull request

Dec 10, 2024

@fmease

This was referenced

Dec 10, 2024

bors added a commit to rust-lang-ci/rust that referenced this pull request

Dec 10, 2024

@bors

Rollup of 11 pull requests

Successful merges:

Failed merges:

r? @ghost @rustbot modify labels: rollup

rust-timer added a commit to rust-lang-ci/rust that referenced this pull request

Dec 10, 2024

@rust-timer

flip1995 pushed a commit to flip1995/rust that referenced this pull request

Dec 15, 2024

@bors

Rollup of 11 pull requests

Successful merges:

Failed merges:

r? @ghost @rustbot modify labels: rollup

rust-cloud-vms bot pushed a commit to aDotInTheVoid/rust that referenced this pull request

Jan 10, 2025

@aDotInTheVoid

rust-cloud-vms bot pushed a commit to aDotInTheVoid/rust that referenced this pull request

Jan 10, 2025

@aDotInTheVoid

rust-cloud-vms bot pushed a commit to aDotInTheVoid/rust that referenced this pull request

Jan 10, 2025

@aDotInTheVoid

Labels

A-rustdoc-json

Area: Rustdoc JSON backend

S-waiting-on-bors

Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

T-rustdoc

Relevant to the rustdoc team, which will review and decide on the PR/issue.