rustdoc: Merge method and tymethod URL fragments and sections

[camelid]

This change was discussed on Zulip here.

Here is an excerpt of my proposal, explaining my rationale:

They add needless complexity to the intra-doc links code (e.g.,
whether an associated item is an impl vs a prototype has to be
hardcoded in some circumstances) and elsewhere in rustdoc. I don't
think there's any need to distinguish between these two kinds. For
example, associated constant prototypes in traits vs definitions in
traits, trait impls, and inherent impls both use associatedconstant.

r? @GuillaumeGomez
cc @jsha

[rust-highfive]

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez,@Folyd

[camelid]

I think the main downside of this change is the breakage of non–intra-doc links. There are a lot of results when I search for #tymethod.. Nearly all of these seem like they should be using intra-doc links instead.

Should we have an FCP given the breakage?

[jsha]

Why not add JS to fixup tymethod fragments on page load?

[camelid]

I guess we could... I just don't want to end up with tons of redirects as we change rustdoc's output over time.

Is there existing code for this or should I add it?

[GuillaumeGomez]

I'd rather not have JS code for that... Such things tend to last much longer than expected. Considering how big the impact is and because it's also a breaking change, FCP is required here.

[camelid]

Hmm, I'm sympathetic to the concern about the redirect lasting too long, but on the other hand, it shouldn't be much code to maintain and the change would otherwise be annoying for users.

[jsha]

The code would be something like (in main.js):

document.addEventListener("DOMContentLoaded", function() {
  let fragment = getPageId();  // getPageId is defined in main.js
  if (fragment.startsWith("tymethod.")) {
    document.location.hash = "#" + fragment.slice(2);
  }
}

[camelid]

I moved the CSS cleanup commit into its own PR: #93444

[rust-log-analyzer]

The job x86_64-gnu-llvm-12 failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)

i....................................................i.............................................. 100/495
.................................................................................................... 200/495
.................................................................................................... 300/495
..............................i..................................................................i.. 400/495
Some tests failed in compiletest suite=rustdoc mode=rustdoc host=x86_64-unknown-linux-gnu target=x86_64-unknown-linux-gnu
..........................F......................................F.............................

---- [rustdoc] rustdoc/source-version-separator.rs stdout ----


error: htmldocck failed!
status: exit status: 1
command: "/usr/bin/python3" "/checkout/src/etc/htmldocck.py" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc/source-version-separator" "/checkout/src/test/rustdoc/source-version-separator.rs"
------------------------------------------

------------------------------------------
stderr:
stderr:
------------------------------------------
9: @has check failed
 `XPATH PATTERN` did not match
     // @has - '//div[@id="tymethod.foo"]/*[@class="rightside"]' '3.0 · source'
Encountered 1 errors

------------------------------------------



---- [rustdoc] rustdoc/trait-impl-items-links-and-anchors.rs stdout ----

error: htmldocck failed!
status: exit status: 1
command: "/usr/bin/python3" "/checkout/src/etc/htmldocck.py" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc/trait-impl-items-links-and-anchors" "/checkout/src/test/rustdoc/trait-impl-items-links-and-anchors.rs"
------------------------------------------

------------------------------------------
stderr:
stderr:
------------------------------------------
17: @has check failed
 `XPATH PATTERN` did not match
     // @has trait_impl_items_links_and_anchors/trait.MyTrait.html '//div[@id="method.trait_function"]//a[@class="anchor"]/@href' #method.trait_function
Encountered 1 errors

------------------------------------------

---
test result: FAILED. 489 passed; 2 failed; 4 ignored; 0 measured; 0 filtered out; finished in 37.66s



command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-tools-bin/compiletest" "--compile-lib-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/lib" "--run-lib-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/lib/rustlib/x86_64-unknown-linux-gnu/lib" "--rustc-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustc" "--rustdoc-path" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustdoc" "--src-base" "/checkout/src/test/rustdoc" "--build-base" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/rustdoc" "--stage-id" "stage2-x86_64-unknown-linux-gnu" "--suite" "rustdoc" "--mode" "rustdoc" "--target" "x86_64-unknown-linux-gnu" "--host" "x86_64-unknown-linux-gnu" "--llvm-filecheck" "/usr/lib/llvm-12/bin/FileCheck" "--nodejs" "/usr/bin/node" "--host-rustcflags" "-Crpath -O -Cdebuginfo=0  -Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--target-rustcflags" "-Crpath -O -Cdebuginfo=0  -Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--docck-python" "/usr/bin/python3" "--lldb-python" "/usr/bin/python3" "--gdb" "/usr/bin/gdb" "--quiet" "--llvm-version" "12.0.0" "--llvm-components" "aarch64 aarch64asmparser aarch64codegen aarch64desc aarch64disassembler aarch64info aarch64utils aggressiveinstcombine all all-targets amdgpu amdgpuasmparser amdgpucodegen amdgpudesc amdgpudisassembler amdgpuinfo amdgpuutils analysis arm armasmparser armcodegen armdesc armdisassembler arminfo armutils asmparser asmprinter avr avrasmparser avrcodegen avrdesc avrdisassembler avrinfo binaryformat bitreader bitstreamreader bitwriter bpf bpfasmparser bpfcodegen bpfdesc bpfdisassembler bpfinfo cfguard codegen core coroutines coverage debuginfocodeview debuginfodwarf debuginfogsym debuginfomsf debuginfopdb demangle dlltooldriver dwarflinker engine executionengine extensions filecheck frontendopenacc frontendopenmp fuzzmutate globalisel hellonew hexagon hexagonasmparser hexagoncodegen hexagondesc hexagondisassembler hexagoninfo instcombine instrumentation interfacestub interpreter ipo irreader jitlink lanai lanaiasmparser lanaicodegen lanaidesc lanaidisassembler lanaiinfo libdriver lineeditor linker lto mc mca mcdisassembler mcjit mcparser mips mipsasmparser mipscodegen mipsdesc mipsdisassembler mipsinfo mirparser msp430 msp430asmparser msp430codegen msp430desc msp430disassembler msp430info native nativecodegen nvptx nvptxcodegen nvptxdesc nvptxinfo objcarcopts object objectyaml option orcjit orcshared orctargetprocess passes perfjitevents powerpc powerpcasmparser powerpccodegen powerpcdesc powerpcdisassembler powerpcinfo profiledata remarks riscv riscvasmparser riscvcodegen riscvdesc riscvdisassembler riscvinfo runtimedyld scalaropts selectiondag sparc sparcasmparser sparccodegen sparcdesc sparcdisassembler sparcinfo support symbolize systemz systemzasmparser systemzcodegen systemzdesc systemzdisassembler systemzinfo tablegen target textapi transformutils vectorize webassembly webassemblyasmparser webassemblycodegen webassemblydesc webassemblydisassembler webassemblyinfo windowsmanifest x86 x86asmparser x86codegen x86desc x86disassembler x86info xcore xcorecodegen xcoredesc xcoredisassembler xcoreinfo xray" "--system-llvm" "--cc" "" "--cxx" "" "--cflags" "" "--adb-path" "adb" "--adb-test-dir" "/data/tmp/work" "--android-cross-path" "" "--channel" "nightly" "--color" "always"


Build completed unsuccessfully in 0:16:11

[bors]

☔ The latest upstream changes (presumably #93655) made this pull request unmergeable. Please resolve the merge conflicts.

[JohnCSimon]

Ping from triage:
@camelid is this PR still active?

[camelid]

I've been meaning to get back to it. Hopefully within the next few weeks I'll be able to finish it. Otherwise, I'll probably close it.

[Dylan-DPC]

Closing this as inactive