diff options
| author | Michael Howell <michael@notriddle.com> | 2023-10-05 18:44:40 -0700 |
|---|---|---|
| committer | Michael Howell <michael@notriddle.com> | 2023-10-22 15:47:34 -0700 |
| commit | ade7ecf90943a7b865a6281112f8b2bbda55dba2 (patch) | |
| tree | ba2d4f6f4ef614e89a6132c42830852661892961 | |
| parent | 54b0434cead71e33bb4ddb52acde7767452b276d (diff) | |
| download | rust-ade7ecf90943a7b865a6281112f8b2bbda55dba2.tar.gz rust-ade7ecf90943a7b865a6281112f8b2bbda55dba2.zip | |
rustdoc: rename `/implementors` to `/impl.trait`
This is shorter, avoids potential conflicts with a crate named `implementors`[^1], and will be less confusing when JS include files are added for type aliases. [^1]: AFAIK, this couldn't actually cause any problems right now, but it's simpler just to make it impossible than relying on never having a file named `trait.Foo.js` in the crate data area.
| -rw-r--r-- | src/librustdoc/html/render/print_item.rs | 8 | ||||
| -rw-r--r-- | src/librustdoc/html/render/write_shared.rs | 2 | ||||
| -rw-r--r-- | tests/rustdoc-gui/code-tags.goml | 2 | ||||
| -rw-r--r-- | tests/rustdoc-gui/item-decl-colors.goml | 2 | ||||
| -rw-r--r-- | tests/rustdoc-gui/no-docblock.goml | 2 | ||||
| -rw-r--r-- | tests/rustdoc-gui/setting-auto-hide-content-large-items.goml | 2 | ||||
| -rw-r--r-- | tests/rustdoc-gui/trait-sidebar-item-order.goml | 2 | ||||
| -rw-r--r-- | tests/rustdoc-gui/type-declation-overflow.goml | 2 | ||||
| -rw-r--r-- | tests/rustdoc/hidden-impls.rs | 2 | ||||
| -rw-r--r-- | tests/rustdoc/impl-parts-crosscrate.rs | 2 | ||||
| -rw-r--r-- | tests/rustdoc/inline_cross/implementors-js.rs | 10 | ||||
| -rw-r--r-- | tests/rustdoc/issue-43701.rs | 2 |
12 files changed, 19 insertions, 19 deletions
diff --git a/src/librustdoc/html/render/print_item.rs b/src/librustdoc/html/render/print_item.rs index f6432dc61ae..b553954845b 100644 --- a/src/librustdoc/html/render/print_item.rs +++ b/src/librustdoc/html/render/print_item.rs @@ -1101,7 +1101,7 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean: // ``` // // Basically, we want `C::Baz` and `A::Foo` to show the same set of - // impls, which is easier if they both treat `/implementors/A/trait.Foo.js` + // impls, which is easier if they both treat `/trait.impl/A/trait.Foo.js` // as the Single Source of Truth. // // We also want the `impl Baz for Quux` to be written to @@ -1110,7 +1110,7 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean: // because that'll load faster, and it's better for SEO. And we don't want // the same impl to show up twice on the same page. // - // To make this work, the implementors JS file has a structure kinda + // To make this work, the trait.impl/A/trait.Foo.js JS file has a structure kinda // like this: // // ```js @@ -1127,7 +1127,7 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean: // So C's HTML will have something like this: // // ```html - // <script src="/implementors/A/trait.Foo.js" + // <script src="/trait.impl/A/trait.Foo.js" // data-ignore-extern-crates="A,B" async></script> // ``` // @@ -1137,7 +1137,7 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean: // [JSONP]: https://en.wikipedia.org/wiki/JSONP let mut js_src_path: UrlPartsBuilder = std::iter::repeat("..") .take(cx.current.len()) - .chain(std::iter::once("implementors")) + .chain(std::iter::once("trait.impl")) .collect(); if let Some(did) = it.item_id.as_def_id() && let get_extern = { || cache.external_paths.get(&did).map(|s| &s.0) } && diff --git a/src/librustdoc/html/render/write_shared.rs b/src/librustdoc/html/render/write_shared.rs index e68d5ab2fbd..b162ea99d8f 100644 --- a/src/librustdoc/html/render/write_shared.rs +++ b/src/librustdoc/html/render/write_shared.rs @@ -362,7 +362,7 @@ if (typeof exports !== 'undefined') {exports.searchIndex = searchIndex}; } // Update the list of all implementors for traits - let dst = cx.dst.join("implementors"); + let dst = cx.dst.join("trait.impl"); let cache = cx.cache(); for (&did, imps) in &cache.implementors { // Private modules can leak through to this phase of rustdoc, which diff --git a/tests/rustdoc-gui/code-tags.goml b/tests/rustdoc-gui/code-tags.goml index 3405d3295e6..577f932e576 100644 --- a/tests/rustdoc-gui/code-tags.goml +++ b/tests/rustdoc-gui/code-tags.goml @@ -1,6 +1,6 @@ // This test ensures that items and documentation code blocks are wrapped in <pre><code> -// We need to disable this check because `implementors/test_docs/trait.AnotherOne.js` +// We need to disable this check because `trait.impl/test_docs/trait.AnotherOne.js` // doesn't exist. fail-on-request-error: false go-to: "file://" + |DOC_PATH| + "/test_docs/fn.foo.html" diff --git a/tests/rustdoc-gui/item-decl-colors.goml b/tests/rustdoc-gui/item-decl-colors.goml index a777842735c..7bbd20c4ee0 100644 --- a/tests/rustdoc-gui/item-decl-colors.goml +++ b/tests/rustdoc-gui/item-decl-colors.goml @@ -1,6 +1,6 @@ // This test ensures that the color of the items in the type decl are working as expected. -// We need to disable this check because `implementors/test_docs/trait.TraitWithoutGenerics.js` +// We need to disable this check because `trait.impl/test_docs/trait.TraitWithoutGenerics.js` // doesn't exist. fail-on-request-error: false diff --git a/tests/rustdoc-gui/no-docblock.goml b/tests/rustdoc-gui/no-docblock.goml index 1b4638ef067..2115b6f5390 100644 --- a/tests/rustdoc-gui/no-docblock.goml +++ b/tests/rustdoc-gui/no-docblock.goml @@ -1,6 +1,6 @@ // This test checks that there are margins applied to methods with no docblocks. -// We need to disable this check because `implementors/test_docs/trait.TraitWithNoDocblock.js` +// We need to disable this check because `trait.impl/test_docs/trait.TraitWithNoDocblock.js` // doesn't exist. fail-on-request-error: false diff --git a/tests/rustdoc-gui/setting-auto-hide-content-large-items.goml b/tests/rustdoc-gui/setting-auto-hide-content-large-items.goml index 6cd725043f4..b55a1cfd92b 100644 --- a/tests/rustdoc-gui/setting-auto-hide-content-large-items.goml +++ b/tests/rustdoc-gui/setting-auto-hide-content-large-items.goml @@ -1,7 +1,7 @@ // This test ensures that the "Auto-hide item contents for large items" setting is working as // expected. -// We need to disable this check because `implementors/test_docs/trait.Iterator.js` doesn't exist. +// We need to disable this check because `trait.impl/test_docs/trait.Iterator.js` doesn't exist. fail-on-request-error: false define-function: ( diff --git a/tests/rustdoc-gui/trait-sidebar-item-order.goml b/tests/rustdoc-gui/trait-sidebar-item-order.goml index 9330ef040ec..73e362ca813 100644 --- a/tests/rustdoc-gui/trait-sidebar-item-order.goml +++ b/tests/rustdoc-gui/trait-sidebar-item-order.goml @@ -1,6 +1,6 @@ // Checks that the elements in the sidebar are alphabetically sorted. -// We need to disable this check because `implementors/test_docs/trait.AnotherOne.js` +// We need to disable this check because `trait.impl/test_docs/trait.AnotherOne.js` // doesn't exist. fail-on-request-error: false diff --git a/tests/rustdoc-gui/type-declation-overflow.goml b/tests/rustdoc-gui/type-declation-overflow.goml index f212781e9b3..5780f5c88f8 100644 --- a/tests/rustdoc-gui/type-declation-overflow.goml +++ b/tests/rustdoc-gui/type-declation-overflow.goml @@ -2,7 +2,7 @@ // This test ensures that the items declaration content overflow is handled inside the <pre> directly. // We need to disable this check because -// `implementors/test_docs/trait.ALongNameBecauseItHelpsTestingTheCurrentProblem.js` +// `trait.impl/test_docs/trait.ALongNameBecauseItHelpsTestingTheCurrentProblem.js` // doesn't exist. fail-on-request-error: false diff --git a/tests/rustdoc/hidden-impls.rs b/tests/rustdoc/hidden-impls.rs index 26e2e0e0660..3283fbfecce 100644 --- a/tests/rustdoc/hidden-impls.rs +++ b/tests/rustdoc/hidden-impls.rs @@ -12,6 +12,6 @@ pub mod __hidden { // @has foo/trait.Clone.html // @!hasraw - 'Foo' -// @has implementors/core/clone/trait.Clone.js +// @has trait.impl/core/clone/trait.Clone.js // @!hasraw - 'Foo' pub use std::clone::Clone; diff --git a/tests/rustdoc/impl-parts-crosscrate.rs b/tests/rustdoc/impl-parts-crosscrate.rs index 34733f1f8cc..da109ea7090 100644 --- a/tests/rustdoc/impl-parts-crosscrate.rs +++ b/tests/rustdoc/impl-parts-crosscrate.rs @@ -12,7 +12,7 @@ pub struct Bar<T> { t: T } // full impl string. Instead, just make sure something from each part // is mentioned. -// @hasraw implementors/rustdoc_impl_parts_crosscrate/trait.AnAutoTrait.js Bar +// @hasraw trait.impl/rustdoc_impl_parts_crosscrate/trait.AnAutoTrait.js Bar // @hasraw - Send // @hasraw - !AnAutoTrait // @hasraw - Copy diff --git a/tests/rustdoc/inline_cross/implementors-js.rs b/tests/rustdoc/inline_cross/implementors-js.rs index c79f05d8d3c..c17d52d0f41 100644 --- a/tests/rustdoc/inline_cross/implementors-js.rs +++ b/tests/rustdoc/inline_cross/implementors-js.rs @@ -4,13 +4,13 @@ extern crate implementors_inline; -// @!has implementors/implementors_js/trait.MyTrait.js -// @has implementors/implementors_inline/my_trait/trait.MyTrait.js -// @!has implementors/implementors_inline/prelude/trait.MyTrait.js +// @!has trait.impl/implementors_js/trait.MyTrait.js +// @has trait.impl/implementors_inline/my_trait/trait.MyTrait.js +// @!has trait.impl/implementors_inline/prelude/trait.MyTrait.js // @has implementors_inline/my_trait/trait.MyTrait.html -// @has - '//script/@src' '../../implementors/implementors_inline/my_trait/trait.MyTrait.js' +// @has - '//script/@src' '../../trait.impl/implementors_inline/my_trait/trait.MyTrait.js' // @has implementors_js/trait.MyTrait.html -// @has - '//script/@src' '../implementors/implementors_inline/my_trait/trait.MyTrait.js' +// @has - '//script/@src' '../trait.impl/implementors_inline/my_trait/trait.MyTrait.js' /// When re-exporting this trait, the HTML will be inlined, /// but, vitally, the JavaScript will be located only at the /// one canonical path. diff --git a/tests/rustdoc/issue-43701.rs b/tests/rustdoc/issue-43701.rs index 44335e961f9..de772881e73 100644 --- a/tests/rustdoc/issue-43701.rs +++ b/tests/rustdoc/issue-43701.rs @@ -2,4 +2,4 @@ pub use std::vec::Vec; -// @!has implementors/core/clone/trait.Clone.js +// @!has trait.impl/core/clone/trait.Clone.js |
