rustdoc documents mut self as mut self: Self #81289

Activity

1. tesuji

   added

   C-bugCategory: This is a bug.Category: This is a bug.

   on Jan 23, 2021
2. rustbot

   added

   regression-from-stable-to-nightlyPerformance or correctness regression from stable to nightly.Performance or correctness regression from stable to nightly.

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

   I-prioritizeIssue needs a team member to assess the impact. Will be replaced by P-{low,medium,high,critical}Issue needs a team member to assess the impact. Will be replaced by P-{low,medium,high,critical}

   on Jan 23, 2021
3. LeSeulArtichaut

   self-assigned this

   on Jan 23, 2021
4. LeSeulArtichaut commented on Jan 23, 2021

   

   LeSeulArtichaut

   on Jan 23, 2021

   Contributor

   More actions

   I'd like to investigate this :)

   👍React with 👍1Reacted by tesuji
5. LeSeulArtichaut commented on Jan 23, 2021

   

   LeSeulArtichaut

   on Jan 23, 2021

   Contributor

   More actions

   searched nightlies: from nightly-2020-12-29 to nightly-2021-01-22
   regressed nightly: nightly-2021-01-09
   searched commits: from c8915ee to 26438b4
   regressed commit: 9155a9d

   This regressed in #80806, so this is probably caused by #80799
6. LeSeulArtichaut commented on Jan 23, 2021

   

   LeSeulArtichaut

   on Jan 23, 2021

   Contributor

   More actions

   This also affects

   fn bar(mut foo) {}

   Where rustdoc will generate:

   fn bar(mut foo: Foo)
   
7. LeSeulArtichaut commented on Jan 23, 2021

   

   LeSeulArtichaut

   on Jan 23, 2021

   Contributor

   More actions

   So a few observations:

   • rustc_hir_pretty::param_to_string uses print_pat which displays mutability in patterns, causing mut to be displayed
   • the mechanism for detecting and eliding : Self works by litterally checking if the pattern is self, but as param_to_string returns mut self instead of self, the comparison fails and rustdoc displays the Self type.
8. LeSeulArtichaut commented on Jan 23, 2021

   

   LeSeulArtichaut

   on Jan 23, 2021

   Contributor

   More actions

   I see two path to solving this bug:

   1. Add an option for rustc_hir_pretty::param_to_string to not display the mutability in patterns
   2. Just revert Get rid of custom pretty-printing in rustdoc #80799

   cc @jyn514 what do you think?
9. jyn514 commented on Jan 24, 2021

   

   jyn514

   on Jan 24, 2021

   Member

   More actions

   I would prefer to go for 1, there's no reason to have two completely different functions for pretty-printing.

   👍React with 👍1Reacted by Léo Lanteri Thauvin
10. camelid

    added

    P-mediumMedium priorityMedium priority

    and removed

    I-prioritizeIssue needs a team member to assess the impact. Will be replaced by P-{low,medium,high,critical}Issue needs a team member to assess the impact. Will be replaced by P-{low,medium,high,critical}

    on Feb 5, 2021
11. camelid commented on Feb 5, 2021

    

    camelid

    on Feb 5, 2021

    Member

    More actions

    Assigning P-medium and removing I-prioritize as discussed in the prioritization working group.
12. camelid

    added

    regression-from-stable-to-betaPerformance or correctness regression from stable to beta.Performance or correctness regression from stable to beta.

    and removed

    regression-from-stable-to-nightlyPerformance or correctness regression from stable to nightly.Performance or correctness regression from stable to nightly.

    on Feb 12, 2021
13. camelid commented on Feb 12, 2021

    

    camelid

    on Feb 12, 2021

    Member

    More actions

    (now a beta regression)
14. jyn514

    added this to the 1.51.0 milestone on Feb 12, 2021
15. JohnTitor

    added 2 commits that reference this issue on Feb 12, 2021

    Rollup merge of rust-lang#81831 - LeSeulArtichaut:81289-mut-arg, r=ca…

    ...

    This issue will close once commit b2c8d7d is merged into the 'main' branch.

    b2c8d7d

    Rollup merge of rust-lang#81831 - LeSeulArtichaut:81289-mut-arg, r=ca…

    ...

    This issue will close once commit 327762f is merged into the 'main' branch.

    327762f
16. bors

    closed this as completedin 327762fon Feb 12, 2021
17. Mark-Simulacrum

    added a commit that references this issue on Feb 13, 2021

    Add regression test for rust-lang#81289

    2d6c4b3