Add missing impl blocks for item reexported from private mod in JSON output by GuillaumeGomez · Pull Request #103653 · rust-lang/rust

GuillaumeGomez · 2022-10-27T19:50:40Z

Since we don't inline for the JSON output, the impl blocks from private modules are not present when we generate the output. To go around this limitation, in case the impl block doesn't have #[doc(hidden)] and is implementing a public item, we don't strip it.

cc @fmease @aDotInTheVoid
r? @notriddle

aDotInTheVoid

Looks good, just some small nits around the test

aDotInTheVoid · 2022-10-27T23:34:17Z

src/test/rustdoc-json/reexport_method_from_private_module.rs

Nit: This should be in src/test/rustdoc-json/reexport.rs

aDotInTheVoid · 2022-10-27T23:36:43Z

src/test/rustdoc-json/reexport_method_from_private_module.rs

Nit: Could you also check that S has an impl block, and the impl block has just the expected method

So, for whatever reason I can't do:

// @has "$.index[*][?(@.kind=='impl' && @.inner.for.inner.name=='S')]"

but this one works:

// @has "$.index[*][?(@.kind=='impl')].inner.for.inner.name" '"S"'

I wanted to use it to use to first count the number of impl blocks for S and then count the number of items in this impl. But since it's not possible, I'll just leave it as is I guess...

// @has "$.index[*][?(@.kind=='impl' && @.inner.for.inner.name=='S')]"

doesn't work due to freestrings/jsonpath#91

The way I to work around this is to add a doc comment to the impl and select on that, eg

pub struct S; //// impl S impl S { pub fn is_present() {} } // @set impl_S = "$.index[*][?(@.docs=='impl S')].id" // @set is_present = "$.index[*][?(@.name=='is_present')].id" // @is "$.index[*][?(@.name=='S')].inner.impls[*]" $impl_S // @is "$.index[*][?(@.docs=='impl S')].inner.items[*]" $is_present

Smart trick! That doesn't allow to see how many impl blocks are implemented on S unfortunately but it's much better than currently. :)

If theirs a second impls on S, then it'll fail because several things match to // @is "$.index[*][?(@.name=='S')].inner.impls[*]" $impl_S, but because this in #[no_core], their are no auto traits.

Similarly, this checks theirs only 1 method in the impl.

Makes sense, thanks for the explanation! Then I guess it's ready for final review. :)

src/test/rustdoc-json/reexport_method_from_private_module.rs

src/librustdoc/passes/stripper.rs

GuillaumeGomez · 2022-10-28T10:18:52Z

Updated! I'm a bit sad I couldn't extend the test as I wanted but I guess it's enough for now. If you find a way to do it, I'd be very interested!

GuillaumeGomez · 2022-10-28T12:36:53Z

Updated! Thanks for the suggestion @aDotInTheVoid !

notriddle · 2022-10-28T13:28:23Z

@bors r+

bors · 2022-10-28T13:28:26Z

📌 Commit 2345cd3155e481bd39ad36c91a2d190edca099ed has been approved by notriddle

It is now in the queue for this repository.

bors · 2022-10-29T07:17:48Z

☔ The latest upstream changes (presumably #102233) made this pull request unmergeable. Please resolve the merge conflicts.

…output

GuillaumeGomez · 2022-10-29T10:31:49Z

@bors r=notriddle rollup

bors · 2022-10-29T10:31:50Z

📌 Commit 0ef36b8 has been approved by notriddle

It is now in the queue for this repository.

…llaumeGomez Rollup of 8 pull requests Successful merges: - rust-lang#102634 (compiletest: Refactor test rustcflags) - rust-lang#102721 (Prevent foreign Rust exceptions from being caught) - rust-lang#103415 (filter candidates in pick probe for diagnostics) - rust-lang#103618 (Rename some `OwnerId` fields.) - rust-lang#103625 (Accept `TyCtxt` instead of `TyCtxtAt` in `Ty::is_*` functions) - rust-lang#103653 (Add missing impl blocks for item reexported from private mod in JSON output) - rust-lang#103699 (Emit proper error when casting to `dyn*`) - rust-lang#103719 (fix typo in `try_reserve` method from `HashMap` and `HashSet`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

…e-json, r=notriddle Add missing impl blocks for item reexported from private mod in JSON output Fixes rust-lang#102583. Since we don't inline for the JSON output, the impl blocks from private modules are not present when we generate the output. To go around this limitation, in case the impl block doesn't have `#[doc(hidden)]` and is implementing a public item, we don't strip it. cc `@fmease` `@aDotInTheVoid` r? `@notriddle`

…llaumeGomez Rollup of 8 pull requests Successful merges: - rust-lang#102634 (compiletest: Refactor test rustcflags) - rust-lang#102721 (Prevent foreign Rust exceptions from being caught) - rust-lang#103415 (filter candidates in pick probe for diagnostics) - rust-lang#103618 (Rename some `OwnerId` fields.) - rust-lang#103625 (Accept `TyCtxt` instead of `TyCtxtAt` in `Ty::is_*` functions) - rust-lang#103653 (Add missing impl blocks for item reexported from private mod in JSON output) - rust-lang#103699 (Emit proper error when casting to `dyn*`) - rust-lang#103719 (fix typo in `try_reserve` method from `HashMap` and `HashSet`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned notriddle Oct 27, 2022

rustbot added A-rustdoc-json Area: Rustdoc JSON backend S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Oct 27, 2022

GuillaumeGomez mentioned this pull request Oct 27, 2022

rustdoc JSON: struct fn missing if re-exported from private mod #102583

Closed

aDotInTheVoid reviewed Oct 27, 2022

View reviewed changes

GuillaumeGomez force-pushed the missing-impl-private-json branch 2 times, most recently from 2ebd3ea to 9c10ef0 Compare October 28, 2022 10:18

GuillaumeGomez force-pushed the missing-impl-private-json branch from 9c10ef0 to 2345cd3 Compare October 28, 2022 12:36

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 Oct 28, 2022

bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 29, 2022

GuillaumeGomez added 2 commits October 29, 2022 11:43

Add missing impl blocks for item reexported from private mod in JSON …

f0234f1

…output

Add regression test for missing item from private mod in JSON output

0ef36b8

GuillaumeGomez force-pushed the missing-impl-private-json branch from 2345cd3 to 0ef36b8 Compare October 29, 2022 09:56

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 29, 2022

GuillaumeGomez mentioned this pull request Oct 29, 2022

Rollup of 8 pull requests #103727

Merged

bors merged commit 05ab16b into rust-lang:master Oct 29, 2022

rustbot added this to the 1.66.0 milestone Oct 29, 2022

GuillaumeGomez deleted the missing-impl-private-json branch October 30, 2022 10:51

Uh oh!

Conversation

GuillaumeGomez commented Oct 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aDotInTheVoid left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez commented Oct 28, 2022

Uh oh!

GuillaumeGomez commented Oct 28, 2022

Uh oh!

notriddle commented Oct 28, 2022

Uh oh!

bors commented Oct 28, 2022

Uh oh!

bors commented Oct 29, 2022

Uh oh!

GuillaumeGomez commented Oct 29, 2022

Uh oh!

bors commented Oct 29, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

GuillaumeGomez commented Oct 27, 2022 •

edited

Loading