Skip to content

Consider different page layouts for rustdoc #74758

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

Open
jyn514 opened this issue Jul 25, 2020 · 0 comments
Open

Consider different page layouts for rustdoc #74758

jyn514 opened this issue Jul 25, 2020 · 0 comments
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. E-hard Call for participation: Hard difficulty. Experience needed to fix: A lot. E-help-wanted Call for participation: Help is requested to fix this issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Comments

@jyn514
Copy link
Member

jyn514 commented Jul 25, 2020

@willcrichton and I were discussing this on discord:

wcrichto: auto-generated docs tend to have a single, immutable structure. But most effective data visualization tools present multiple views on the same data, depending on the task at hand. Would it make sense for rustdoc to have multiple layouts? And the user could pick the one that makes the most sense for their question.
jynelson: sure :) we could even make the default layout configurable, we have settings already
wcrichto: One possibility would be to improve the visual design of the docs to more easily give an overview of all the methods on a type. In the split_at_mut, even literally just putting all the methods into 2D grid instead of a 1D list could be helpful. There are ~180 methods on the Vec documentation, which is overwhelming to look through.
jynelson: you mean something like 'Method Summary' and 'Field Summary' from javadocs?
wcrichto: Yeah maybe! But with basic grouping/filtering. Like: "group by whether method takes &self or &mut self".

Grouping by &self/&mut self/self would be a neat grouping, but I'm sure there are many others possible. It would be great to have different ways of visualizing how to manipulate types.

Related: type-based searching (seems to be currently broken? #60485 (comment))

@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-enhancement Category: An issue proposing an enhancement or a PR with one. E-help-wanted Call for participation: Help is requested to fix this issue. labels Jul 25, 2020
@jyn514 jyn514 added the E-hard Call for participation: Hard difficulty. Experience needed to fix: A lot. label Dec 21, 2020
@fmease fmease added A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. E-hard Call for participation: Hard difficulty. Experience needed to fix: A lot. E-help-wanted Call for participation: Help is requested to fix this issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Development

No branches or pull requests

3 participants