aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTimo Freiberg <[email protected]>2020-05-05 22:36:35 +0100
committerTimo Freiberg <[email protected]>2020-05-06 17:09:28 +0100
commit8a5d14453e464edeb8613df2fdca742bfe2a72f5 (patch)
treeabe9e4889964fa1f2020d2f93a27374aee0f0229
parente99447ffbf77b17674dc047e5a9f5aff9480ed1c (diff)
Add fixture doc comment
-rw-r--r--crates/ra_db/src/fixture.rs46
-rw-r--r--xtask/tests/tidy.rs1
2 files changed, 45 insertions, 2 deletions
diff --git a/crates/ra_db/src/fixture.rs b/crates/ra_db/src/fixture.rs
index 8248684ee..51d4c493e 100644
--- a/crates/ra_db/src/fixture.rs
+++ b/crates/ra_db/src/fixture.rs
@@ -1,4 +1,48 @@
1//! FIXME: write short doc here 1//! Fixtures are strings containing rust source code with optional metadata.
2//! A fixture without metadata is parsed into a single source file.
3//! Use this to test functionality local to one file.
4//!
5//! Example:
6//! ```
7//! r#"
8//! fn main() {
9//! println!("Hello World")
10//! }
11//! "#
12//! ```
13//!
14//! Metadata can be added to a fixture after a `//-` comment.
15//! The basic form is specifying filenames,
16//! which is also how to define multiple files in a single test fixture
17//!
18//! Example:
19//! ```
20//! "
21//! //- /main.rs
22//! mod foo;
23//! fn main() {
24//! foo::bar();
25//! }
26//!
27//! //- /foo.rs
28//! pub fn bar() {}
29//! "
30//! ```
31//!
32//! Metadata allows specifying all settings and variables
33//! that are available in a real rust project:
34//! - crate names via `crate:cratename`
35//! - dependencies via `deps:dep1,dep2`
36//! - configuration settings via `cfg:dbg=false,opt_level=2`
37//! - environment variables via `env:PATH=/bin,RUST_LOG=debug`
38//!
39//! Example:
40//! ```
41//! "
42//! //- /lib.rs crate:foo deps:bar,baz cfg:foo=a,bar=b env:OUTDIR=path/to,OTHER=foo
43//! fn insert_source_code_here() {}
44//! "
45//! ```
2 46
3use std::str::FromStr; 47use std::str::FromStr;
4use std::sync::Arc; 48use std::sync::Arc;
diff --git a/xtask/tests/tidy.rs b/xtask/tests/tidy.rs
index c4eac1bc4..b8e8860ba 100644
--- a/xtask/tests/tidy.rs
+++ b/xtask/tests/tidy.rs
@@ -136,7 +136,6 @@ impl TidyDocs {
136 } 136 }
137 137
138 let whitelist = [ 138 let whitelist = [
139 "ra_db",
140 "ra_hir", 139 "ra_hir",
141 "ra_hir_expand", 140 "ra_hir_expand",
142 "ra_ide", 141 "ra_ide",