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]>

8 files changed, 48 insertions, 32 deletions

diff --git a/crates/ra_ide_api/src/snapshots/tests__highlight_query_group_macro.snap b/crates/ra_ide_api/src/snapshots/tests__highlight_query_group_macro.snap
index b84aa9c78..062add083 100644
--- a/crates/ra_ide_api/src/snapshots/tests__highlight_query_group_macro.snap
+++ b/crates/ra_ide_api/src/snapshots/tests__highlight_query_group_macro.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-15T11:15:20.732493641+00:00
-Creator: [email protected]
-Source: crates/ra_ide_api/src/syntax_highlighting.rs
-
+---
+created: "2019-01-22T14:45:01.017117100+00:00"
+creator: [email protected]
+expression: "&highlights"
+source: "crates\\ra_ide_api\\src\\syntax_highlighting.rs"
+---
 [
     HighlightedRange {
         range: [20; 32),
diff --git a/crates/ra_ide_api/src/snapshots/tests__highlights_code_inside_macros.snap b/crates/ra_ide_api/src/snapshots/tests__highlights_code_inside_macros.snap
index 14c6e5a4e..fd8265abb 100644
--- a/crates/ra_ide_api/src/snapshots/tests__highlights_code_inside_macros.snap
+++ b/crates/ra_ide_api/src/snapshots/tests__highlights_code_inside_macros.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-15T11:15:20.732523231+00:00
-Creator: [email protected]
-Source: crates/ra_ide_api/src/syntax_highlighting.rs
-
+---
+created: "2019-01-22T14:45:01.043047100+00:00"
+creator: [email protected]
+expression: "&highlights"
+source: "crates\\ra_ide_api\\src\\syntax_highlighting.rs"
+---
 [
     HighlightedRange {
         range: [13; 15),
diff --git a/crates/ra_ide_api/src/snapshots/tests__rename_mod.snap b/crates/ra_ide_api/src/snapshots/tests__rename_mod.snap
index dc97b3334..3267d1ac5 100644
--- a/crates/ra_ide_api/src/snapshots/tests__rename_mod.snap
+++ b/crates/ra_ide_api/src/snapshots/tests__rename_mod.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-18T08:26:43.427092+00:00
-Creator: [email protected]
-Source: crates/ra_ide_api/src/rename.rs
-
+---
+created: "2019-01-22T14:45:00.975229300+00:00"
+creator: [email protected]
+expression: "&source_change"
+source: "crates\\ra_ide_api\\src\\rename.rs"
+---
 Some(
     SourceChange {
         label: "rename",
diff --git a/crates/ra_ide_api/src/snapshots/tests__rename_mod_in_dir.snap b/crates/ra_ide_api/src/snapshots/tests__rename_mod_in_dir.snap
index 7dcd65185..e96bf5c02 100644
--- a/crates/ra_ide_api/src/snapshots/tests__rename_mod_in_dir.snap
+++ b/crates/ra_ide_api/src/snapshots/tests__rename_mod_in_dir.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-18T08:26:43.427095+00:00
-Creator: [email protected]
-Source: crates/ra_ide_api/src/rename.rs
-
+---
+created: "2019-01-22T14:45:00.975229300+00:00"
+creator: [email protected]
+expression: "&source_change"
+source: "crates\\ra_ide_api\\src\\rename.rs"
+---
 Some(
     SourceChange {
         label: "rename",
diff --git a/crates/ra_ide_api/src/snapshots/tests__runnables.snap b/crates/ra_ide_api/src/snapshots/tests__runnables.snap
index ba6cba0ab..71bd7a4bd 100644
--- a/crates/ra_ide_api/src/snapshots/tests__runnables.snap
+++ b/crates/ra_ide_api/src/snapshots/tests__runnables.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-15T11:15:20.732460119+00:00
-Creator: [email protected]
-Source: crates/ra_ide_api/src/runnables.rs
-
+---
+created: "2019-01-22T14:45:00.975229300+00:00"
+creator: [email protected]
+expression: "&runnables"
+source: "crates\\ra_ide_api\\src\\runnables.rs"
+---
 [
     Runnable {
         range: [1; 21),
diff --git a/crates/ra_ide_api/src/snapshots/tests__runnables_module.snap b/crates/ra_ide_api/src/snapshots/tests__runnables_module.snap
index b3f2d4d6e..a28dd8952 100644
--- a/crates/ra_ide_api/src/snapshots/tests__runnables_module.snap
+++ b/crates/ra_ide_api/src/snapshots/tests__runnables_module.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-15T11:15:20.732460109+00:00
-Creator: [email protected]
-Source: crates/ra_ide_api/src/runnables.rs
-
+---
+created: "2019-01-22T14:45:00.976230700+00:00"
+creator: [email protected]
+expression: "&runnables"
+source: "crates\\ra_ide_api\\src\\runnables.rs"
+---
 [
     Runnable {
         range: [1; 59),
diff --git a/crates/ra_ide_api/src/snapshots/tests__runnables_multiple_depth_module.snap b/crates/ra_ide_api/src/snapshots/tests__runnables_multiple_depth_module.snap
index 6eba482e7..79f07bef9 100644
--- a/crates/ra_ide_api/src/snapshots/tests__runnables_multiple_depth_module.snap
+++ b/crates/ra_ide_api/src/snapshots/tests__runnables_multiple_depth_module.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-15T11:15:20.732522773+00:00
-Creator: [email protected]
-Source: crates/ra_ide_api/src/runnables.rs
-
+---
+created: "2019-01-22T14:45:00.979218100+00:00"
+creator: [email protected]
+expression: "&runnables"
+source: "crates\\ra_ide_api\\src\\runnables.rs"
+---
 [
     Runnable {
         range: [41; 115),
diff --git a/crates/ra_ide_api/src/snapshots/tests__runnables_one_depth_layer_module.snap b/crates/ra_ide_api/src/snapshots/tests__runnables_one_depth_layer_module.snap
index f40c762f3..d199e9073 100644
--- a/crates/ra_ide_api/src/snapshots/tests__runnables_one_depth_layer_module.snap
+++ b/crates/ra_ide_api/src/snapshots/tests__runnables_one_depth_layer_module.snap
@@ -1,7 +1,9 @@
-Created: 2019-01-15T11:15:20.732480089+00:00
-Creator: [email protected]
-Source: crates/ra_ide_api/src/runnables.rs
-
+---
+created: "2019-01-22T14:45:01.016119500+00:00"
+creator: [email protected]
+expression: "&runnables"
+source: "crates\\ra_ide_api\\src\\runnables.rs"
+---
 [
     Runnable {
         range: [23; 85),