mirror of
https://github.com/rust-lang/rust.git
synced 2025-05-03 13:37:37 +00:00
574830f573
Begin fixing all the broken doctests in `compiler/` Begins to fix #95994. All of them pass now but 24 of them I've marked with `ignore HELP (<explanation>)` (asking for help) as I'm unsure how to get them to work / if we should leave them as they are. There are also a few that I marked `ignore` that could maybe be made to work but seem less important. Each `ignore` has a rough "reason" for ignoring after it parentheses, with - `(pseudo-rust)` meaning "mostly rust-like but contains foreign syntax" - `(illustrative)` a somewhat catchall for either a fragment of rust that doesn't stand on its own (like a lone type), or abbreviated rust with ellipses and undeclared types that would get too cluttered if made compile-worthy. - `(not-rust)` stuff that isn't rust but benefits from the syntax highlighting, like MIR. - `(internal)` uses `rustc_*` code which would be difficult to make work with the testing setup. Those reason notes are a bit inconsistently applied and messy though. If that's important I can go through them again and try a more principled approach. When I run `rg '```ignore \(' .` on the repo, there look to be lots of different conventions other people have used for this sort of thing. I could try unifying them all if that would be helpful. I'm not sure if there was a better existing way to do this but I wrote my own script to help me run all the doctests and wade through the output. If that would be useful to anyone else, I put it here: https://github.com/Elliot-Roberts/rust_doctest_fixing_tool |
||
|---|---|---|
| .. | ||
| base_n | ||
| binary_search_util | ||
| fingerprint | ||
| flock | ||
| graph | ||
| intern | ||
| obligation_forest | ||
| owning_ref | ||
| sip128 | ||
| small_c_str | ||
| small_str | ||
| snapshot_map | ||
| sorted_map | ||
| sso | ||
| stable_hasher | ||
| tagged_ptr | ||
| thin_vec | ||
| tiny_list | ||
| transitive_relation | ||
| vec_map | ||
| atomic_ref.rs | ||
| base_n.rs | ||
| captures.rs | ||
| fingerprint.rs | ||
| flock.rs | ||
| frozen.rs | ||
| functor.rs | ||
| fx.rs | ||
| intern.rs | ||
| jobserver.rs | ||
| lib.rs | ||
| macros.rs | ||
| map_in_place.rs | ||
| memmap.rs | ||
| profiling.rs | ||
| sharded.rs | ||
| sip128.rs | ||
| small_c_str.rs | ||
| small_str.rs | ||
| sorted_map.rs | ||
| stable_hasher.rs | ||
| stable_map.rs | ||
| stable_set.rs | ||
| stack.rs | ||
| steal.rs | ||
| svh.rs | ||
| sync.rs | ||
| tagged_ptr.rs | ||
| temp_dir.rs | ||
| thin_vec.rs | ||
| tiny_list.rs | ||
| transitive_relation.rs | ||
| unhash.rs | ||
| vec_linked_list.rs | ||
| vec_map.rs | ||
| work_queue.rs | ||