Skip to content

Default docs.rs setting is harder to navigate #60215

Closed
@Firstyear

Description

@Firstyear

Docs.rs (after this change https://github.com/rust-lang/rust/pull/49954/files ) now collapses function definitions by default. This means that the default view a consumer of documentation now sees:

Screen Shot 2019-04-24 at 07 56 31

The small "[+]" as a symbol is really hard to notice, and so people can easily overlook that it's there - I know I would not have thought to click it unless I was told to, and I now have people asking if my libraries are documented at all (they are), but they don't see it because of the default collapse.

There are a few changes I would suggest here to make this more user-interaction and human friendly:

  • The function definitions should be expanded by default and the setting should be per-user to collapse (This is this issue here).
  • The item should be "[+ expand]" or "[- collapse]" - text helps people to understand the way to use an item, where currently you could over look the "[+]" as a list marker instead. Docs rs "[+]" ui element does not afford usage clearly #60255
  • The settings in the settings menu don't seem to "persist" so, that's a unique problem of itself. (Already open issue)

Thank you!

EDIT: Added missing link.
EDIT 2: Clarify this issue's context and add link.

Metadata

Metadata

Assignees

No one assigned

    Labels

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

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions