Add a comment to `Compiler`.

It took me a while to work this out.
This commit is contained in:
Nicholas Nethercote 2022-10-11 11:43:25 +11:00
parent cf13d9143d
commit 5d716fd0e9
1 changed files with 4 additions and 1 deletions

View File

@ -25,7 +25,10 @@ use std::result;
pub type Result<T> = result::Result<T, ErrorGuaranteed>;
/// Represents a compiler session.
/// Represents a compiler session. Note that every `Compiler` contains a
/// `Session`, but `Compiler` also contains some things that cannot be in
/// `Session`, due to `Session` being in a crate that has many fewer
/// dependencies than this crate.
///
/// Can be used to run `rustc_interface` queries.
/// Created by passing [`Config`] to [`run_compiler`].