Skip to content

rustdoc: [src] view is broken in lynx #84242

Closed

Description

@jyn514

I tried this: Opening https://rust-for-linux.github.io/docs/src/kernel/sync/condvar.rs.html#19-23 in lynx.

I expected to see this happen: Either the source code is shown side-by-side with the line numbers, or the line numbers aren't shown at all.

Instead, this happened: image

I think there's a very old issue about this that was fixed for newer browsers, but I can't seem to find it. This has definitely happened on ancient docs in docs.rs before. cc @ojeda - is this something you care about? I saw someone mentioned it in https://lkml.org/lkml/2021/4/16/49 but I don't know if that was actually serious.

Meta

Not sure what rust-for-linux is using, but I can replicate the issue with rustdoc 1.53.0-nightly (d0695c9 2021-04-12).

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    C-bugCategory: This is a bug.
    A-rustdoc-uiArea: Rustdoc UI (generated HTML)
    on Apr 16, 2021
  2. ojeda commented on Apr 16, 2021

    @ojeda
    Contributor

    I think we will need to see the overall sentiment from the kernel community. Reading the source code directly is good enough in my opinion, since Markdown is designed to be readable as-is, but we will see.

    Perhaps it is easier to have a plain-text renderer in rustdoc than to try to keep the other docs always working in TUI browsers.

  3. ojeda commented on Apr 16, 2021

    @ojeda
    Contributor

    Not sure what rust-for-linux is using, but I can replicate the issue with rustdoc 1.53.0-nightly (d0695c9 2021-04-12).

    Currently we recommend 2021-02-20 as that's the one we use in our CI.

    By the way, thanks a lot for taking a look at this! :)

  4. jyn514 commented on Apr 16, 2021

    @jyn514
    MemberAuthor

    Perhaps it is easier to have a plain-text renderer in rustdoc than to try to keep the other docs always working in TUI browsers.

    That will be a lot more work 😅 to be perfectly frank I don't think rustdoc will ever have a renderer other than HTML, my hope is that the JSON format will stabilize enough that people can use it to write their own community backends.

  5. ojeda commented on Apr 16, 2021

    @ojeda
    Contributor

    Sure! A format-independent renderer like the JSON one would be enough.

  6. lolbinarycat commented on Jan 16, 2025

    @lolbinarycat
    Contributor

    one possible workaround would be adding the attributes hidden="" style="display: block;" to the pre element that contains the line numbers. since hidden is often implemented as display: none;, this will show the numbers on most modern browsers (only tested firefox), and not show it on browsers that don't support css.

  7. added a commit that references this issue on Feb 12, 2025
    ba32d8b
  8. added a commit that references this issue on Feb 12, 2025
    60306e7
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-uiArea: Rustdoc UI (generated HTML)C-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

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions