Add a visibility suggestion in private-in-public errors #113983

nyurik · 2023-07-23T17:10:49Z

This modifies the original #112540 by @aryan-debug to fix #112284

This PR introduces a new field vis_sugg to suggest the proper visibility for the error.

TODO: What should the TODO values be here? Note that not a single test anywhere has used these ???TODO??? values, so it is unclear how they can be generated. Maybe this whole match should be simplified to map Restricted(_) => "pub(crate)" ?

let vis_sugg = match self.required_visibility {
    ty::Visibility::Public => "pub",
    ty::Visibility::Restricted(vis_def_id) => {
        if vis_def_id == self.tcx.parent_module(hir_id) {
            "???TODO???"
        } else if vis_def_id.is_top_level_module() {
            "pub(crate)"
        } else {
            "???TODO???"
        }
    }
};

rustbot · 2023-07-23T17:10:55Z

r? @WaffleLapkin

(rustbot has picked a reviewer for you, use r? to override)

WaffleLapkin · 2023-07-23T18:49:53Z

r? compiler-errors

petrochenkov · 2023-07-23T19:13:08Z

I don't think this change is still relevant after #113126.

nyurik · 2023-07-24T03:37:49Z

@petrochenkov thx for the heads up! I looked through that PR (even left a comment), but I'm not certain I understand if it will cover all cases?

I see this change adds self.in_assoc_ty bool, so clearly the error will still exist if its an associated type? Is this planned to change as well? Should the suggestion I did in this PR be addapted to #113126?

if self.in_assoc_ty && !vis.is_at_least(self.required_visibility, self.tcx) {

compiler-errors · 2023-07-26T19:31:11Z

r? petrochenkov

petrochenkov · 2023-07-26T20:30:46Z

Blocked on #113126.
@rustbot blocked

petrochenkov · 2023-09-01T15:17:11Z

#113126 has landed.
@rustbot author

Dylan-DPC · 2023-11-02T14:45:38Z

@nyurik any updates?

nyurik · 2023-11-02T23:21:37Z

@Dylan-DPC thx for the ping, i have updated the PR, but it still has some outstanding questions that need some feedback. Thx!

nyurik · 2023-11-13T18:12:20Z

@petrochenkov hi, would you be the right person to review this? I would love to move forward, but it is a bit unclear. Plus @JohnCSimon was pinging the original author of this PR (before my refactoring). Hopefully the outstanding questions can be easily addressed. Thx!!

petrochenkov · 2023-11-13T21:36:05Z

@petrochenkov hi, would you be the right person to review this?

Yes, but maybe a bit later, I'm busy this week.

petrochenkov · 2023-11-24T15:07:10Z

compiler/rustc_privacy/src/lib.rs

@@ -1475,12 +1475,31 @@ impl SearchInterfaceForPrivateItemsVisitor<'_> {
                }
            };

+            // FIXME: this code was adapted from the above `vis_descr` computation,
+            //        but it's not clear if it's correct.


I think fn vis_to_string should be usable here.

I am not sure it will work. I tried to

add rustc_ast_pretty = { path = "../rustc_ast_pretty" } to Cargo.toml

use it with let vis_sugg = rustc_ast_pretty::pprust::vis_to_string(&self.required_visibility);

But the ty::Visibility that I have here -- enum { Default, Hidden, Protected } is not the same as the one vis_to_string expects -- a struct ast::Visibility with kind/span/tokens. Is there a way i can get the struct?

I meant ty::Visibility::to_string, not vis_to_string from rustc_ast_pretty, sorry.

ty::Visibility::to_string was also called vis_to_string when this comment was written, but it was renamed in #115993.

petrochenkov · 2023-11-24T15:10:08Z

compiler/rustc_privacy/src/errors.rs

    pub descr: DiagnosticArgFromDisplay<'a>,
    #[label(privacy_visibility_label)]
    pub vis_span: Span,
+    #[suggestion(code = "", applicability = "maybe-incorrect")]


The suggested visibility should probably go to the code here, rather than to the suggestion message.

rustbot · 2024-01-12T04:38:25Z

There are merge commits (commits with multiple parents) in your changes. We have a no merge policy so these commits will need to be removed for this pull request to be merged.

You can start a rebase with the following commands:

$ # rebase
$ git rebase -i master
$ # delete any merge commits in the editor that appears
$ git push --force-with-lease

The following commits are merge commits:

7ebf1a8

Dylan-DPC · 2024-02-12T13:32:56Z

@nyurik any updates on replying to the changes requested in the review and implement them accordingly?

nyurik

Thx for the ping! I am still interested in this PR, but got a bit stuck on implementing it

nyurik · 2024-01-12T06:01:13Z

compiler/rustc_privacy/src/lib.rs

@@ -1475,12 +1475,31 @@ impl SearchInterfaceForPrivateItemsVisitor<'_> {
                }
            };

+            // FIXME: this code was adapted from the above `vis_descr` computation,
+            //        but it's not clear if it's correct.


I am not sure it will work. I tried to

add rustc_ast_pretty = { path = "../rustc_ast_pretty" } to Cargo.toml

use it with let vis_sugg = rustc_ast_pretty::pprust::vis_to_string(&self.required_visibility);

But the ty::Visibility that I have here -- enum { Default, Hidden, Protected } is not the same as the one vis_to_string expects -- a struct ast::Visibility with kind/span/tokens. Is there a way i can get the struct?

bors · 2024-02-28T23:20:58Z

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

rustbot assigned WaffleLapkin Jul 23, 2023

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Jul 23, 2023

nyurik changed the title ~~Pub in priv err~~ Add a visibility suggestion in private-in-public errors Jul 23, 2023

nyurik mentioned this pull request Jul 23, 2023

Add a suggestion to add or remove pub on private-in-public error #112540

Closed

This comment has been minimized.

Sign in to view

nyurik force-pushed the pub-in-priv-err branch from ad5d3b9 to e9c1d6d Compare July 23, 2023 17:19

rustbot assigned compiler-errors and unassigned WaffleLapkin Jul 23, 2023

rustbot assigned petrochenkov and unassigned compiler-errors Jul 26, 2023

rustbot added S-blocked Status: Marked as blocked ❌ on something else such as an RFC or other implementation work. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 26, 2023

This comment was marked as resolved.

Sign in to view

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-blocked Status: Marked as blocked ❌ on something else such as an RFC or other implementation work. labels Sep 1, 2023

nyurik force-pushed the pub-in-priv-err branch from e9c1d6d to bb3e619 Compare November 2, 2023 23:21

petrochenkov 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 Nov 3, 2023

petrochenkov reviewed Nov 24, 2023

View reviewed changes

petrochenkov 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 Nov 24, 2023

This comment was marked as resolved.

Sign in to view

rustbot added the has-merge-commits PR has merge commits, merge with caution. label Jan 12, 2024

aryan-debug and others added 4 commits January 11, 2024 23:40

Issue#112284

b2829e5

Added suggestion instead of help

712ef4e

fixed formatting issues

314c4e3

Suggest proper vis type in the help message

95db42f

nyurik force-pushed the pub-in-priv-err branch from 7ebf1a8 to 95db42f Compare January 12, 2024 04:41

dtolnay removed the has-merge-commits PR has merge commits, merge with caution. label Jan 21, 2024

nyurik commented Feb 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a visibility suggestion in private-in-public errors #113983

Add a visibility suggestion in private-in-public errors #113983

nyurik commented Jul 23, 2023 •

edited

rustbot commented Jul 23, 2023

This comment has been minimized.

WaffleLapkin commented Jul 23, 2023

petrochenkov commented Jul 23, 2023

nyurik commented Jul 24, 2023

compiler-errors commented Jul 26, 2023

petrochenkov commented Jul 26, 2023

This comment was marked as resolved.

petrochenkov commented Sep 1, 2023

Dylan-DPC commented Nov 2, 2023

nyurik commented Nov 2, 2023

nyurik commented Nov 13, 2023

petrochenkov commented Nov 13, 2023

petrochenkov Nov 24, 2023

nyurik Jan 12, 2024

petrochenkov Feb 12, 2024

petrochenkov Nov 24, 2023

This comment was marked as resolved.

rustbot commented Jan 12, 2024

Dylan-DPC commented Feb 12, 2024

nyurik left a comment

nyurik Jan 12, 2024

bors commented Feb 28, 2024

Add a visibility suggestion in private-in-public errors #113983

Are you sure you want to change the base?

Add a visibility suggestion in private-in-public errors #113983

Conversation

nyurik commented Jul 23, 2023 • edited

rustbot commented Jul 23, 2023

This comment has been minimized.

WaffleLapkin commented Jul 23, 2023

petrochenkov commented Jul 23, 2023

nyurik commented Jul 24, 2023

compiler-errors commented Jul 26, 2023

petrochenkov commented Jul 26, 2023

This comment was marked as resolved.

petrochenkov commented Sep 1, 2023

Dylan-DPC commented Nov 2, 2023

nyurik commented Nov 2, 2023

nyurik commented Nov 13, 2023

petrochenkov commented Nov 13, 2023

petrochenkov Nov 24, 2023

Choose a reason for hiding this comment

nyurik Jan 12, 2024

Choose a reason for hiding this comment

petrochenkov Feb 12, 2024

Choose a reason for hiding this comment

petrochenkov Nov 24, 2023

Choose a reason for hiding this comment

This comment was marked as resolved.

rustbot commented Jan 12, 2024

Dylan-DPC commented Feb 12, 2024

nyurik left a comment

Choose a reason for hiding this comment

nyurik Jan 12, 2024

Choose a reason for hiding this comment

bors commented Feb 28, 2024

nyurik commented Jul 23, 2023 •

edited