Merge #593

593: Docs for completion r=matklad a=kjeremy

The first commit adds documentation support to CompletionItems.

The second one I am unsure about. Is that the right way to add docs for functions? If so should I do something similar for other `hir` types and CompletionItems?

Co-authored-by: Jeremy Kolb <[email protected]>
Co-authored-by: Jeremy A. Kolb <[email protected]>

24 files changed, 144 insertions, 96 deletions

diff --git a/crates/ra_hir/src/ty/snapshots/tests__bug_484.snap b/crates/ra_hir/src/ty/snapshots/tests__bug_484.snap
index eeb3061d3..28f57623d 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__bug_484.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__bug_484.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.662863951+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.880187500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [11; 37) '{    l... {}; }': ()
 [20; 21) 'x': ()
 [24; 34) 'if true {}': ()
diff --git a/crates/ra_hir/src/ty/snapshots/tests__bug_585.snap b/crates/ra_hir/src/ty/snapshots/tests__bug_585.snap
index 073009bbc..e7b42e413 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__bug_585.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__bug_585.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.662863969+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.880187500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [11; 89) '{     ...   } }': ()
 [17; 21) 'X {}': [unknown]
 [27; 87) 'match ...     }': ()
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_adt_pattern.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_adt_pattern.snap
index fb261f1c0..2719f592e 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_adt_pattern.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_adt_pattern.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.662935249+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.880187500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [68; 262) '{     ...  d; }': ()
 [78; 79) 'e': E
 [82; 95) 'E::A { x: 3 }': E
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_array.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_array.snap
index 2fc613e26..3f2faa598 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_array.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_array.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.662961921+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.880187500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [9; 10) 'x': &str
 [18; 19) 'y': isize
 [28; 293) '{     ... []; }': ()
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_backwards.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_backwards.snap
index 12f0d8c90..5c74bd8c7 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_backwards.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_backwards.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.662902243+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.880187500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [14; 15) 'x': u32
 [22; 24) '{}': ()
 [78; 231) '{     ...t &c }': &mut &f64
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_basics.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_basics.snap
index eba8126e9..4b0863558 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_basics.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_basics.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.662874226+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.880187500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [9; 10) 'a': u32
 [17; 18) 'b': isize
 [27; 28) 'c': !
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_binary_op.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_binary_op.snap
index 3b750ec45..c506bcadd 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_binary_op.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_binary_op.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.662972146+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.880187500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [6; 7) 'x': bool
 [22; 34) '{     0i32 }': i32
 [28; 32) '0i32': i32
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_enum.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_enum.snap
index 8018ff025..bc8b84272 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_enum.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_enum.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.662949719+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.880187500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [48; 82) '{   E:...:V2; }': ()
 [52; 70) 'E::V1 ...d: 1 }': E
 [67; 68) '1': u32
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_field_autoderef.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_field_autoderef.snap
index 1943ef079..f092fd319 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_field_autoderef.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_field_autoderef.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.671554939+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.955954900+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [44; 45) 'a': A
 [50; 213) '{     ...5.b; }': ()
 [60; 62) 'a1': A
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_function_generics.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_function_generics.snap
index 386acc0b3..7203ad1e2 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_function_generics.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_function_generics.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.669112954+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.954958500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [10; 11) 't': [unknown]
 [21; 26) '{ t }': [unknown]
 [23; 24) 't': [unknown]
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_generic_chain.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_generic_chain.snap
index 7a64e4f95..4435180a1 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_generic_chain.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_generic_chain.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.672467086+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.961936900+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [53; 57) 'self': A<[unknown]>
 [65; 87) '{     ...     }': [unknown]
 [75; 79) 'self': A<[unknown]>
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_generics_in_patterns.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_generics_in_patterns.snap
index ae38ec2fb..fae7ab0dd 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_generics_in_patterns.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_generics_in_patterns.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.683908196+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.970913200+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [79; 81) 'a1': A<u32>
 [91; 92) 'o': Option<u64>
 [107; 244) '{     ...  }; }': ()
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_inherent_method.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_inherent_method.snap
index 298dac585..b3c706aca 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_inherent_method.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_inherent_method.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.670255659+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.968918800+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [32; 36) 'self': A
 [38; 39) 'x': u32
 [53; 55) '{}': ()
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_let.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_let.snap
index aa4e4cc63..0d085071a 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_let.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_let.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.666406651+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.963931700+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [11; 71) '{     ...= b; }': ()
 [21; 22) 'a': isize
 [25; 31) '1isize': isize
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_literals.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_literals.snap
index 00c7e639e..e287a100e 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_literals.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_literals.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.666200994+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.974903100+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [11; 201) '{     ...o"#; }': ()
 [17; 21) '5i32': i32
 [27; 34) '"hello"': &str
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_paths.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_paths.snap
index 0924cdc80..0bceffaef 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_paths.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_paths.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.671399345+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:44:59.975899500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [15; 20) '{ 1 }': u32
 [17; 18) '1': u32
 [48; 53) '{ 1 }': u32
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_pattern.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_pattern.snap
index b22b71765..1da46daf8 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_pattern.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_pattern.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.677661229+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:45:00.037734500+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [9; 10) 'x': &i32
 [18; 369) '{     ...o_x; }': ()
 [28; 29) 'y': &i32
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_refs.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_refs.snap
index fc5bfe677..56931bb3d 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_refs.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_refs.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.674183006+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:45:00.053692600+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [9; 10) 'a': &u32
 [18; 19) 'b': &mut u32
 [31; 32) 'c': *const u32
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_self.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_self.snap
index 76cb62055..84c8b1e90 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_self.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_self.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:50:17.870325361+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:45:00.052694700+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [34; 38) 'self': &S
 [40; 61) '{     ...     }': ()
 [50; 54) 'self': &S
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_struct.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_struct.snap
index 0c94d6837..c4a2d5cf8 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_struct.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_struct.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.677495622+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:45:00.058678600+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [72; 154) '{     ...a.c; }': ()
 [82; 83) 'c': [unknown]
 [86; 87) 'C': [unknown]
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_struct_generics.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_struct_generics.snap
index 7cf947d4d..e07c7d36c 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_struct_generics.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_struct_generics.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.678274444+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:45:00.058678600+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [36; 38) 'a1': A<u32>
 [48; 49) 'i': i32
 [56; 147) '{     ...3.x; }': ()
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_tuple.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_tuple.snap
index 862644145..cd11d41d3 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_tuple.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_tuple.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.676903109+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:45:00.058678600+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [9; 10) 'x': &str
 [18; 19) 'y': isize
 [28; 170) '{     ...d"); }': ()
diff --git a/crates/ra_hir/src/ty/snapshots/tests__infer_unary_op.snap b/crates/ra_hir/src/ty/snapshots/tests__infer_unary_op.snap
index 8906bb9c0..10aa61954 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__infer_unary_op.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__infer_unary_op.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.676213204+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:45:00.059676600+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [27; 28) 'x': SomeType
 [40; 197) '{     ...lo"; }': ()
 [50; 51) 'b': bool
diff --git a/crates/ra_hir/src/ty/snapshots/tests__no_panic_on_field_of_enum.snap b/crates/ra_hir/src/ty/snapshots/tests__no_panic_on_field_of_enum.snap
index 024fbf929..b6f404b4c 100644
--- a/crates/ra_hir/src/ty/snapshots/tests__no_panic_on_field_of_enum.snap
+++ b/crates/ra_hir/src/ty/snapshots/tests__no_panic_on_field_of_enum.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-21T21:48:20.676654355+00:00
-Creator: [email protected]
-Source: crates/ra_hir/src/ty/tests.rs
-
+---
+created: "2019-01-22T14:45:00.058678600+00:00"
+creator: [email protected]
+expression: "&result"
+source: "crates\\ra_hir\\src\\ty\\tests.rs"
+---
 [20; 21) 'x': X
 [26; 47) '{     ...eld; }': ()
 [32; 33) 'x': X