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 sidebar order is not deterministic #29698

Closed
nagisa opened this issue Nov 8, 2015 · 0 comments
Closed

rustdoc sidebar order is not deterministic #29698

nagisa opened this issue Nov 8, 2015 · 0 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@nagisa
Copy link
Member

nagisa commented Nov 8, 2015

Sections appearing on the sidebar seem to not have a deterministic order and can result in variations like the attached screenshot. The order probably should be deterministic and go either Structs → Modules → Crates or Crates→ Mdoules → Struct.

Reloading the page many times seems to successfully reproduce the issue here.

screenshot from 2015-11-08 20-23-27
screenshot from 2015-11-08 20-23-22

@sfackler sfackler added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Nov 9, 2015
shssoichiro pushed a commit to shssoichiro/rust that referenced this issue Nov 18, 2015
A race condition in Javascript was causing unpredictable ordering
of the sidebar boxes when loading documentation generated by
rustdoc, due to the script that adds the Crates box being executed
asynchronously. Disabling the asynchronous execution and deferring
this script should ensure that the Crates box always appears last
in the sidebox (this seemed to be the more common ordering prior
to this change).

Fixes rust-lang#29698
bors added a commit that referenced this issue Nov 19, 2015
A race condition in Javascript was causing unpredictable ordering
of the sidebar boxes when loading documentation generated by
rustdoc, due to the script that adds the Crates box being executed
asynchronously. Disabling the asynchronous execution and deferring
this script should ensure that the Crates box always appears last
in the sidebox (this seemed to be the more common ordering prior
to this change).

Fixes #29698
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

2 participants