aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2020-06-08 11:52:28 +0100
committerAleksey Kladov <[email protected]>2020-06-08 11:52:28 +0100
commitee8dec5dc11cfecf219b6510b0eadd9691a82ba5 (patch)
tree2685efeb77e02baca1c820d2637e46df1fed05b7
parentd8552d114c3b2cedbc485ebe26d7b784c0845bd8 (diff)
IDE API
-rw-r--r--docs/dev/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index 903cb4055..64d595b68 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -268,6 +268,13 @@ IDE assumes that all information is available at all times.
268IDE should use only types from `ra_hir`, and should not depend on the underling compiler types. 268IDE should use only types from `ra_hir`, and should not depend on the underling compiler types.
269`ra_hir` is a facade. 269`ra_hir` is a facade.
270 270
271## IDE API
272
273The main IDE crate (`ra_ide`) uses "Plain Old Data" for the API.
274Rather than talking in definitions and references, it talks in Strings and textual offsets.
275In general, API is centered around UI concerns -- the result of the call is what the user sees in the editor, and not what the compiler sees underneath.
276The results are 100% Rust specific though.
277
271# Logging 278# Logging
272 279
273Logging is done by both rust-analyzer and VS Code, so it might be tricky to 280Logging is done by both rust-analyzer and VS Code, so it might be tricky to