mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
cf2dff2b1e
rust/tests/rustdoc/intra-doc/basic.rs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

85 lines
3.0 KiB
Rust
Raw Normal View History

Move `src/test/rustdoc` intra-doc link tests into a subdirectory They were starting to get unwieldy.
2020-11-28 19:25:41 -06:00
// @has basic/index.html
rustdoc: use more precise relative URLS Instead of using a depth counter and adding "../" to get to the top, this commit makes rustdoc actually compare the path of what it's linking from to the path that it's linking to. This makes the resulting HTML shorter. Here's a comparison of one of the largest (non-source) files in the Rust standard library docs (about 4% improvement before gzipping). $ wc -c struct.Wrapping.old.html struct.Wrapping.new.html 2387389 struct.Wrapping.old.html 2298538 struct.Wrapping.new.html Most if it can be efficiently gzipped away. $ wc -c struct.Wrapping.old.html.gz struct.Wrapping.new.html.gz 70679 struct.Wrapping.old.html.gz 70050 struct.Wrapping.new.html.gz But it also makes a difference in the final DOM size, reducing it from 91MiB to 82MiB.
2021-03-17 13:41:01 -05:00
// @has - '//a/@href' 'struct.ThisType.html'
// @has - '//a/@href' 'struct.ThisType.html#method.this_method'
// @has - '//a/@href' 'enum.ThisEnum.html'
// @has - '//a/@href' 'enum.ThisEnum.html#variant.ThisVariant'
// @has - '//a/@href' 'trait.ThisTrait.html'
// @has - '//a/@href' 'trait.ThisTrait.html#tymethod.this_associated_method'
// @has - '//a/@href' 'trait.ThisTrait.html#associatedtype.ThisAssociatedType'
// @has - '//a/@href' 'trait.ThisTrait.html#associatedconstant.THIS_ASSOCIATED_CONST'
// @has - '//a/@href' 'trait.ThisTrait.html'
// @has - '//a/@href' 'type.ThisAlias.html'
// @has - '//a/@href' 'union.ThisUnion.html'
// @has - '//a/@href' 'fn.this_function.html'
// @has - '//a/@href' 'constant.THIS_CONST.html'
// @has - '//a/@href' 'static.THIS_STATIC.html'
// @has - '//a/@href' 'macro.this_macro.html'
// @has - '//a/@href' 'trait.SoAmbiguous.html'
// @has - '//a/@href' 'fn.SoAmbiguous.html'
add basic test for rustdoc intra links
2017-12-28 16:48:30 -06:00
//! In this crate we would like to link to:
//!
add a macro to the intra-links test
2018-01-07 17:09:16 -06:00
//! * [`ThisType`](ThisType)
Add tests
2018-01-24 22:41:25 -06:00
//! * [`ThisType::this_method`](ThisType::this_method)
add a macro to the intra-links test
2018-01-07 17:09:16 -06:00
//! * [`ThisEnum`](ThisEnum)
Add tests
2018-01-24 22:41:25 -06:00
//! * [`ThisEnum::ThisVariant`](ThisEnum::ThisVariant)
overhaul intra-doc-link ambiguity warning - Makes the warning part of the `intra_doc_link_resolution_failure` lint. - Tightens the span to just the ambiguous link. - Reports ambiguities across all three namespaces. - Uses structured suggestions for disambiguation. - Adds a test for the warnings.
2019-02-28 12:54:19 -06:00
//! * [`ThisEnum::ThisVariantCtor`](ThisEnum::ThisVariantCtor)
add a macro to the intra-links test
2018-01-07 17:09:16 -06:00
//! * [`ThisTrait`](ThisTrait)
Add tests
2018-01-24 22:41:25 -06:00
//! * [`ThisTrait::this_associated_method`](ThisTrait::this_associated_method)
//! * [`ThisTrait::ThisAssociatedType`](ThisTrait::ThisAssociatedType)
//! * [`ThisTrait::THIS_ASSOCIATED_CONST`](ThisTrait::THIS_ASSOCIATED_CONST)
add a macro to the intra-links test
2018-01-07 17:09:16 -06:00
//! * [`ThisAlias`](ThisAlias)
//! * [`ThisUnion`](ThisUnion)
value-namespace items require a marker, so emit an error
2018-01-08 13:20:19 -06:00
//! * [`this_function`](this_function())
//! * [`THIS_CONST`](const@THIS_CONST)
//! * [`THIS_STATIC`](static@THIS_STATIC)
add a macro to the intra-links test
2018-01-07 17:09:16 -06:00
//! * [`this_macro`](this_macro!)
add ambiguity markers to the intra-links test
2018-01-08 09:33:27 -06:00
//!
//! In addition, there's some specifics we want to look at. There's [a trait called
//! SoAmbiguous][ambig-trait], but there's also [a function called SoAmbiguous][ambig-fn] too!
//! Whatever shall we do?
//!
//! [ambig-trait]: trait@SoAmbiguous
//! [ambig-fn]: SoAmbiguous()
add a macro to the intra-links test
2018-01-07 17:09:16 -06:00
#[macro_export]
macro_rules! this_macro {
() => {};
}
add basic test for rustdoc intra links
2017-12-28 16:48:30 -06:00
rustdoc: use more precise relative URLS Instead of using a depth counter and adding "../" to get to the top, this commit makes rustdoc actually compare the path of what it's linking from to the path that it's linking to. This makes the resulting HTML shorter. Here's a comparison of one of the largest (non-source) files in the Rust standard library docs (about 4% improvement before gzipping). $ wc -c struct.Wrapping.old.html struct.Wrapping.new.html 2387389 struct.Wrapping.old.html 2298538 struct.Wrapping.new.html Most if it can be efficiently gzipped away. $ wc -c struct.Wrapping.old.html.gz struct.Wrapping.new.html.gz 70679 struct.Wrapping.old.html.gz 70050 struct.Wrapping.new.html.gz But it also makes a difference in the final DOM size, reducing it from 91MiB to 82MiB.
2021-03-17 13:41:01 -05:00
// @has basic/struct.ThisType.html '//a/@href' 'macro.this_macro.html'
Add test
2020-07-09 12:27:48 -05:00
/// another link to [`this_macro!()`]
add basic test for rustdoc intra links
2017-12-28 16:48:30 -06:00
pub struct ThisType;
Add tests
2018-01-24 22:41:25 -06:00
impl ThisType {
pub fn this_method() {}
}
overhaul intra-doc-link ambiguity warning - Makes the warning part of the `intra_doc_link_resolution_failure` lint. - Tightens the span to just the ambiguous link. - Reports ambiguities across all three namespaces. - Uses structured suggestions for disambiguation. - Adds a test for the warnings.
2019-02-28 12:54:19 -06:00
pub enum ThisEnum { ThisVariant, ThisVariantCtor(u32), }
Add tests
2018-01-24 22:41:25 -06:00
pub trait ThisTrait {
type ThisAssociatedType;
const THIS_ASSOCIATED_CONST: u8;
fn this_associated_method();
}
add basic test for rustdoc intra links
2017-12-28 16:48:30 -06:00
pub type ThisAlias = Result<(), ()>;
pub union ThisUnion { this_field: usize, }
pub fn this_function() {}
pub const THIS_CONST: usize = 5usize;
pub static THIS_STATIC: usize = 5usize;
add ambiguity markers to the intra-links test
2018-01-08 09:33:27 -06:00
pub trait SoAmbiguous {}
Replace usages of 'bad_style' with 'nonstandard_style'. `bad_style` is being deprecated in favor of `nonstandard_style`: - https://github.com/rust-lang/rust/issues/41646
2018-08-29 08:21:01 -05:00
#[allow(nonstandard_style)]
add ambiguity markers to the intra-links test
2018-01-08 09:33:27 -06:00
pub fn SoAmbiguous() {}
Add test
2018-02-18 16:55:48 -06:00
rustdoc: use more precise relative URLS Instead of using a depth counter and adding "../" to get to the top, this commit makes rustdoc actually compare the path of what it's linking from to the path that it's linking to. This makes the resulting HTML shorter. Here's a comparison of one of the largest (non-source) files in the Rust standard library docs (about 4% improvement before gzipping). $ wc -c struct.Wrapping.old.html struct.Wrapping.new.html 2387389 struct.Wrapping.old.html 2298538 struct.Wrapping.new.html Most if it can be efficiently gzipped away. $ wc -c struct.Wrapping.old.html.gz struct.Wrapping.new.html.gz 70679 struct.Wrapping.old.html.gz 70050 struct.Wrapping.new.html.gz But it also makes a difference in the final DOM size, reducing it from 91MiB to 82MiB.
2021-03-17 13:41:01 -05:00
// @has basic/struct.SomeOtherType.html '//a/@href' 'struct.ThisType.html'
// @has - '//a/@href' 'struct.ThisType.html#method.this_method'
// @has - '//a/@href' 'enum.ThisEnum.html'
// @has - '//a/@href' 'enum.ThisEnum.html#variant.ThisVariant'
Add test
2018-02-18 16:55:48 -06:00
/// Shortcut links for:
/// * [`ThisType`]
/// * [`ThisType::this_method`]
/// * [ThisEnum]
/// * [ThisEnum::ThisVariant]
pub struct SomeOtherType;
Reference in New Issue Copy Permalink