Skip to content
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 and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustdoc doesn't save filtered crate for search #100265

Open
pravic opened this issue Aug 8, 2022 · 7 comments
Open

rustdoc doesn't save filtered crate for search #100265

pravic opened this issue Aug 8, 2022 · 7 comments
Labels
A-rustdoc-search Area: Rustdoc's search feature C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Milestone

Comments

@pravic
Copy link
Contributor

pravic commented Aug 8, 2022

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
@pravic pravic added C-bug Category: This is a bug. regression-untriaged Untriaged performance or correctness regression. labels Aug 8, 2022
@rustbot rustbot added the I-prioritize Issue: Indicates that prioritization has been requested for this issue. label Aug 8, 2022
@pravic
Copy link
Contributor Author

pravic commented Aug 8, 2022

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

@rustbot rustbot added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-search Area: Rustdoc's search feature labels Aug 8, 2022
@pravic
Copy link
Contributor Author

pravic commented Aug 8, 2022

@rustbot modify labels: +T-rustdoc

@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 8, 2022
@camelid
Copy link
Member

camelid commented Aug 8, 2022

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

@camelid camelid added regression-from-stable-to-stable Performance or correctness regression from one stable version to another. and removed regression-untriaged Untriaged performance or correctness regression. labels Aug 8, 2022
@camelid camelid added this to the 1.60.0 milestone Aug 8, 2022
@pravic
Copy link
Contributor Author

pravic commented Aug 9, 2022

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.

@GuillaumeGomez
Copy link
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.

@pravic
Copy link
Contributor Author

pravic commented Aug 9, 2022

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

@GuillaumeGomez
Copy link
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? :)

@GuillaumeGomez GuillaumeGomez removed regression-from-stable-to-stable Performance or correctness regression from one stable version to another. I-prioritize Issue: Indicates that prioritization has been requested for this issue. labels Aug 24, 2022
@GuillaumeGomez GuillaumeGomez removed the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Sep 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-search Area: Rustdoc's search feature C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

4 participants