Skip to content

rustdoc doesn't save filtered crate for search #100265

Open

Description

@pravic

Originally:

Starting from 1.60:

I expected to see this happen: the search filter should persist.

Instead, this happened: the search filter resets every time we go to the result.

Version it worked on

It most recently worked on: 1.59

Version with regression

rustc --version --verbose:

rustc 1.62.0 (a8314ef7d 2022-06-27)
binary: rustc
commit-hash: a8314ef7d0ec7b75c336af2c9857bfaf43002bfc
commit-date: 2022-06-27
host: x86_64-unknown-linux-gnu
release: 1.62.0
LLVM version: 14.0.5

Activity

  1. added
    C-bugCategory: This is a bug.
    regression-untriagedUntriaged performance or correctness regression.
    on Aug 8, 2022
  2. added
    I-prioritizeIssue needs a team member to assess the impact. Will be replaced by P-{low,medium,high,critical}
    on Aug 8, 2022
  3. pravic commented on Aug 8, 2022

    @pravic
    ContributorAuthor

    @rustbot modify labels: +A-docs +A-rustdoc-search

  4. added
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    on Aug 8, 2022
  5. pravic commented on Aug 8, 2022

    @pravic
    ContributorAuthor

    @rustbot modify labels: +T-rustdoc

  6. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Aug 8, 2022
  7. camelid commented on Aug 8, 2022

    @camelid
    Member

    I think this was an intentional change. Some people (including myself) preferred having the crate filtering be stateless. This may be the PR: #92735

    cc @GuillaumeGomez

  8. added
    regression-from-stable-to-stablePerformance or correctness regression from one stable version to another.
    and removed
    regression-untriagedUntriaged performance or correctness regression.
    on Aug 8, 2022
  9. added this to the 1.60.0 milestone on Aug 8, 2022
  10. pravic commented on Aug 9, 2022

    @pravic
    ContributorAuthor

    Some people (including myself) preferred having the crate filtering be stateless.

    I think, in this case just don't use the filtering? Or (better) we need to include this in the settings ("save crates filter/choice"). Just dropping the filtering state is a UX breaking change.

    Not to mention that now we are forced to select the crate filter each time we search. I think, the amount of "select std in the filter" is insanely larger than "I always used 'std', now I need 'core' - I have to reset the filter" use cases.

  11. GuillaumeGomez commented on Aug 9, 2022

    @GuillaumeGomez
    Member

    This is an intentional change. There are multiple things backing this change:

    • On local docs, if you change folder, the setting is lost, adding confusion for users about the saved crate filter.
    • Search is a "one time thing" and anything you do in it won't be save once you change page.

    I'm not sure adding a new setting for this would fix your issue either since you'd have the same problem in any case on local docs.

  12. pravic commented on Aug 9, 2022

    @pravic
    ContributorAuthor

    Local docs - it's a separate beast that almost nobody uses. People use doc.rust-lang.org and docs.rs.

  13. GuillaumeGomez commented on Aug 9, 2022

    @GuillaumeGomez
    Member

    Local docs - it's a separate beast that almost nobody uses. People use doc.rust-lang.org and docs.rs.

    That is a very bold statement. I hope you have some numbers to back it up? :)

  14. removed
    regression-from-stable-to-stablePerformance or correctness regression from one stable version to another.
    I-prioritizeIssue needs a team member to assess the impact. Will be replaced by P-{low,medium,high,critical}
    on Aug 24, 2022
  15. removed
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    on Sep 25, 2022
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-searchArea: Rustdoc's search featureC-bugCategory: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions