1
Fork 0

doc: misc rustdoc things

This commit is contained in:
Tshepang Lekhonkhobe 2020-05-01 22:32:33 +02:00
parent a91d64873f
commit 5314f0126c
2 changed files with 7 additions and 5 deletions

View file

@ -233,6 +233,7 @@ fn generate_test_harness(
///
/// By default this expands to
///
/// ```
/// #[main]
/// pub fn main() {
/// extern crate test;
@ -242,6 +243,7 @@ fn generate_test_harness(
/// &test_const3,
/// ]);
/// }
/// ```
///
/// Most of the Ident have the usual def-site hygiene for the AST pass. The
/// exception is the `test_const`s. These have a syntax context that has two
@ -253,8 +255,8 @@ fn generate_test_harness(
///
/// The expansion here can be controlled by two attributes:
///
/// `reexport_test_harness_main` provides a different name for the `main`
/// function and `test_runner` provides a path that replaces
/// [`TestCtxt::reexport_test_harness_main`] provides a different name for the `main`
/// function and [`TestCtxt::test_runner`] provides a path that replaces
/// `test::test_main_static`.
fn mk_main(cx: &mut TestCtxt<'_>) -> P<ast::Item> {
let sp = cx.def_site;

View file

@ -6,9 +6,9 @@
//! other phases of the compiler, which are generally required to hold in order
//! to compile the program at all.
//!
//! Most lints can be written as `LintPass` instances. These run after
//! Most lints can be written as [LintPass] instances. These run after
//! all other analyses. The `LintPass`es built into rustc are defined
//! within `rustc_session::lint::builtin`,
//! within [rustc_session::lint::builtin],
//! which has further comments on how to add such a lint.
//! rustc can also load user-defined lint plugins via the plugin mechanism.
//!
@ -19,7 +19,7 @@
//! example) requires more effort. See `emit_lint` and `GatherNodeLevels`
//! in `context.rs`.
//!
//! Some code also exists in `rustc_session::lint`, `rustc_middle::lint`.
//! Some code also exists in [rustc_session::lint], [rustc_middle::lint].
//!
//! ## Note
//!