Added linting to the documentation. (#92)

README.md

@@ -3,9 +3,11 @@
 
 # Rust for Visual Studio Code (Latest: 0.3.7)
 
-## Why the fork?
+## What is the repository?
 
-RustyCode is no longer maintained and the developer seems to have lost all interest in the extension. Due to no response from the original author, this fork was created which now contains additional features and many bug fixes.
+The extension is continuation of RustyCode (an extension for Visual Studio Code for Rust language).
+
+RustyCode is no longer maintained and the developer seems to have lost all interest in the extension. Due to no response from the original author, this repository was created which now contains additional features and many bug fixes.
 
 ## Extension
 

doc/format.md

@@ -2,7 +2,7 @@
 
 The extension supports formatting the document opened in the active text editor on saving.
 
-If the extension is runnning in [RLS Mode](rls_mode.md), formatting is performed via `rustfmt` integrated into RLS.
+If the extension is runnning in [RLS Mode](rls_mode/main.md), formatting is performed via `rustfmt` integrated into RLS.
 
 If the extension is running in [Legacy Mode](legacy_mode/main.md), formatting is performed via separate `rustfmt`.
 

doc/legacy_mode/linting.md

@@ -0,0 +1,29 @@
+# Linting In Legacy Mode
+
+Executing a cargo command makes the extension parse the the command's output and show diagnostics.
+
+Legacy Mode cannot show diagnostics as you type, for that you should use [RLS Mode](../rls_mode/linting.md).
+
+Let's assume we have the following code:
+
+```rust
+fn main() {
+    let x = 5 + "10";
+}
+```
+
+We then execute any cargo command. Let's execute ["Cargo: Build"](../cargo_command_execution.md).
+
+It builds and shows diagnostics:
+
+* In the source code:
+
+[![Linting](../../images/linting/code.jpg)]()
+
+* And In the Problems panel:
+
+[![Linting](../../images/linting/problems_panel_legacy_mode.jpg)]()
+
+We can hover over any diagnostic to see what it is:
+
+[![Linting](../../images/linting/code_hover_legacy_mode.jpg)]()

doc/linting.md

@@ -0,0 +1,23 @@
+# Linting Page
+
+The extension provides linting as shown in the following screenshot:
+
+[![Linting](../images/linting/code.jpg)]()
+
+It also populates the Problems panel.
+
+For the code:
+
+```rust
+fn foo(i: i32) {}
+
+fn main() {
+    foo(2i64);
+}
+```
+
+The Problems panel would look like:
+
+[![Linting](../images/linting/problems_panel.jpg)]()
+
+Linting behaves differently in [RLS Mode](rls_mode/linting.md) than in [Legacy Mode](legacy_mode/linting.md).

doc/main.md

@@ -9,15 +9,16 @@ The documentation describes features supported by the extension.
 The extension can function in one of two modes:
 
 * [Legacy Mode](legacy_mode/main.md)
-* [Rust Language Server Mode](rls_mode.md)
+* [Rust Language Server Mode](rls_mode/main.md)
 
 Each mode is described in detail on its own page.
 
-Furthermore, the extension allows:
+Furthermore, the extension provides:
 
-* [To execute one of built-in cargo command](cargo_command_execution.md)
-* [To create a playground](playground_creation.md)
-* [To format a document opened in the active text editor](format.md)
+* [Linting (the showing of diagnostics in the active text editor)](linting.md)
+* [Executing one of built-in cargo command](cargo_command_execution.md)
+* [Creating a playground](playground_creation.md)
+* [Formatting a document opened in the active text editor](format.md)
 
 Also it provides snippets and keybindings.
 

doc/rls_mode/linting.md

@@ -0,0 +1,15 @@
+# Linting in Rust Language Server Mode
+
+RLS checks the project and shows diagnostics while you are typing.
+
+You can see diagnostics in the Problems panel.
+
+You can hover over a diagnostic to see what the problem is.
+
+Executing a cargo command doesn't show any diagnostics (unlike [Legacy Mode](../legacy_mode/linting.md)).
+
+It is intentional design decision.
+
+The reason is that there is no pretty way to hide a diagnostic after the diagnostic's cause is fixed.
+
+That (the showing of a problem which has been already fixed) may confuse people, hence the decision.