Skip to content

sidebars for rust documentation pages should use semantic markup #16310

Closed
@froydnj

Description

@froydnj

Looking at, for instance, doc/std/io/index.html after building, I see things like (newlines added for readability):

<p class='location'><a href='../index.html'>std</a></p>
<div class='block mod'>
<h2>Modules</h2>
<a class='mod ' href='../any/index.html'>any</a>
<a class='mod ' href='../ascii/index.html'>ascii</a>
...

The a elements would be much better wrapped inside a list whose elements are marked display-style: inline or somesuch. In textual browsers, the aforementioned bit of markup renders as:

anyasciibitflagsboolc_strc_veccellcharclonecmpcollectionscommdefaultdynamic_libf32f64finallyfmtfrom_strgchashi16i32i64i8intintrinsicsioiterkindslocal_datamacrosmemnumops
optionosownedpathpreludeptrrandrawrcresultrtsimdslicestrstringsynctaskto_strtupletyu16u32u64u8uintunstableve

which is rather unhelpful.

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