Added linting to the documentation. #92

KalitaAlexey · 2017-02-18T08:35:49Z

Hello everyone.

I want you to review and say what you want me to add.

@redactedscribe you know what I want you to do.

Thanks

Fixes #90

redactedscribe · 2017-02-19T00:07:26Z

doc/linting.md

@@ -0,0 +1,23 @@
+# Linging Page


redactedscribe · 2017-02-19T00:13:47Z

doc/linting.md

@@ -0,0 +1,23 @@
+# Linging Page
+
+The extension provides linting which looks like in the following screenshot:


The extension provides linting as shown in the following screenshot:

redactedscribe · 2017-02-19T00:14:55Z

doc/linting.md

+}
+```
+
+The Problems panel looks like in the following screenshot:


The Problems panel would look like:

Why would? It is a fact, isn't it?

"Would" because the code above is a hypothetical example/scenario. You can use "will" if you prefer. Either works.

redactedscribe · 2017-02-19T00:15:29Z

doc/linting.md

+
+[![Linting](../images/linting/problems_panel.jpg)]()
+
+Linting works different in [Legacy Mode](legacy_mode/linting.md) and [RLS Mode](rls_mode/linting.md).


Linting behaves differently in [RLS Mode](rls_mode/linting.md) than in [Legacy Mode](legacy_mode/linting.md).

The linting page should also mention which linting mode is the default.

There is no default mode.

@redactedscribe,
I meant that the chosen mode depended on which mode the extension was running on.

redactedscribe · 2017-02-19T00:17:34Z

doc/main.md

@@ -13,6 +13,10 @@ The extension can function in one of two modes:

 Each mode is described in detail on its own page.

+Furthermore, the extension provides:
+
+* [Linting (Showing diagnostics in the active text editor)](linting.md)


[Linting (the showing of diagnostics in the active text editor)](linting.md)

I assume you are describing what linting is, and it is: "the showing of diagnostics in the active text editor".

I didn't know that it is possible. Thank you.

redactedscribe · 2017-02-19T00:20:47Z

doc/main.md

@@ -13,6 +13,10 @@ The extension can function in one of two modes:

 Each mode is described in detail on its own page.

+Furthermore, the extension provides:


On line 20, you repeat yourself with another sentence beginning with "Furthermore`. Try to avoid repetition. The use of "Furthermore" tends to only be used once to add additional reinforcement to something, in this case, the features of the extension.

redactedscribe · 2017-02-19T00:23:19Z

doc/rls_mode/linting.md

+
+You can see diagnostics in the Problems Panel.
+
+You can hover on a diagnostics to see what the diagnostic is.


You can also hover over a diagnostic to see what the problem is.

redactedscribe · 2017-02-19T00:28:59Z

doc/legacy_mode/linting.md

@@ -0,0 +1,27 @@
+# Legacy Mode Linting Page


I think adding "Page" to the end of each documentation page is unnecessary. Linting in Legacy Mode I believe describes the page better.

redactedscribe · 2017-02-19T00:29:18Z

doc/rls_mode/linting.md

@@ -0,0 +1,15 @@
+# RLS Mode Linting Page


Linting in RLS Mode

redactedscribe · 2017-02-19T00:35:33Z

doc/linting.md

+
+[![Linting](../images/linting/code.jpg)]()
+
+Also it populates the Problems panel.


It also populates the Problems panel.

redactedscribe · 2017-02-19T00:37:01Z

doc/legacy_mode/linting.md

+}
+```
+
+We execute any cargo command. Let's execute "Cargo: Build".


We then execute any cargo command. Let's execute "Cargo: Build".

redactedscribe · 2017-02-19T00:55:17Z

doc/legacy_mode/linting.md

+
+It builds and shows diagnostics:
+
+* In code:


In the source code:

redactedscribe · 2017-02-19T00:56:21Z

doc/legacy_mode/linting.md

+
+[![Linting](../../images/linting/code.jpg)]()
+
+* In the Problems panel:


And in the Problems panel:

redactedscribe · 2017-02-19T00:56:41Z

doc/legacy_mode/linting.md

+
+[![Linting](../../images/linting/problems_panel_legacy_mode.jpg)]()
+
+We can hover any diagnostic to see what it is:


We can hover over any diagnostic to see what it is:

redactedscribe · 2017-02-19T01:07:02Z

doc/legacy_mode/linting.md

@@ -0,0 +1,27 @@
+# Legacy Mode Linting Page
+
+Executing a cargo command makes the extension parse the output of the executed command and show diagnostics.


Executing a cargo command makes the extension parse the command's output and show diagnostics. Legacy Mode cannot show diagnostics as you type, for that you must use [RLS Mode](rls_mode/linting.md).

redactedscribe · 2017-02-19T01:09:27Z

doc/rls_mode/linting.md

@@ -0,0 +1,15 @@
+# RLS Mode Linting Page
+
+`RLS` checks the project and shows diagnostics while you are typing.


Must RLS be in code format?

redactedscribe · 2017-02-19T01:10:00Z

doc/rls_mode/linting.md

+
+`RLS` checks the project and shows diagnostics while you are typing.
+
+You can see diagnostics in the Problems Panel.


You can see diagnostics in the Problems panel.

I don't get this one.

Simply, "Panel" is capitalised whereas in previous mentions you said "Problems panel".

redactedscribe · 2017-02-19T01:10:55Z

doc/rls_mode/linting.md

+
+You can hover on a diagnostics to see what the diagnostic is.
+
+Executing a cargo command doesn't show any diagnostics.


Executing a cargo command doesn't show any diagnostics (unlike [Legacy Mode](legacy_mode/linting.md)).

redactedscribe · 2017-02-19T01:22:30Z

doc/rls_mode/linting.md

+
+Executing a cargo command doesn't show any diagnostics.
+
+It is intentional decision.


This is an intentional design decision.

redactedscribe · 2017-02-19T01:24:42Z

doc/rls_mode/linting.md

+
+The reason is that there is no pretty way to hide a diagnostic after the diagnostic's cause is fixed.
+
+It may confuse people.


What may confuse people? The old diagnostics after a fix?
This would be confusing, hence the decision. ?

redactedscribe · 2017-02-19T01:31:36Z

In future, it would be easier to provide me push access to the necessary branch so I may help with such an edit. The English is now better, however the structure could use improvement by combining some of the single-line sentences into paragraphs / chunks.

KalitaAlexey · 2017-02-19T08:25:42Z

@redactedscribe,
How could I give you access to a branch?

redactedscribe · 2017-02-19T16:01:42Z

@KalitaAlexey I'm not entirely sure, perhaps it's possible through the GitHub interface? I don't use git very often. With access I could edit directly, but currently I cannot.

This help doc looks related: https://help.github.com/articles/about-branch-restrictions/

KalitaAlexey · 2017-02-19T16:12:05Z

I will read the article.
Next time I would give you access.
Thank you again.

KalitaAlexey · 2017-02-19T16:35:40Z

@redactedscribe,
The article isn't about it.
It is related, but it doesn't help right now.
After moving to the organization account I am making master be protected one and make some people be collaborators.
After that collaborators would have access.
This is what the article about.

KalitaAlexey added 2 commits February 18, 2017 11:35

Added linting to the documentation.

cab3896

Commited unsaved changes.

4e1eabd

redactedscribe reviewed Feb 19, 2017

View reviewed changes

doc/linting.md Outdated

@@ -0,0 +1,23 @@

# Linging Page

Copy link

Contributor

redactedscribe Feb 19, 2017 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linting

redactedscribe reviewed Feb 19, 2017

View reviewed changes

doc/rls_mode/linting.md Outdated

@@ -0,0 +1,15 @@

# RLS Mode Linting Page

Copy link

Contributor

redactedscribe Feb 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linting in RLS Mode

redactedscribe reviewed Feb 19, 2017

View reviewed changes

KalitaAlexey added 3 commits February 20, 2017 00:26

Changed the documentation according to the suggestions.

16bc448

Merge branch 'master' into add-linting-to-doc

12456fe

Changed "Why the fork" to "What is the repository".

62c8641

KalitaAlexey merged commit 067efc3 into master Feb 20, 2017

KalitaAlexey deleted the add-linting-to-doc branch February 20, 2017 05:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added linting to the documentation. #92

Added linting to the documentation. #92

KalitaAlexey commented Feb 18, 2017 •

edited

Loading

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017

KalitaAlexey Feb 19, 2017

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017 •

edited

Loading

KalitaAlexey Feb 19, 2017

KalitaAlexey Feb 19, 2017

redactedscribe Feb 19, 2017

KalitaAlexey Feb 19, 2017

redactedscribe Feb 19, 2017

KalitaAlexey Feb 19, 2017

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017

KalitaAlexey Feb 19, 2017

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe commented Feb 19, 2017

KalitaAlexey commented Feb 19, 2017

redactedscribe commented Feb 19, 2017 •

edited

Loading

KalitaAlexey commented Feb 19, 2017

KalitaAlexey commented Feb 19, 2017 •

edited

Loading

		@@ -0,0 +1,23 @@
		# Linging Page

		The extension provides linting which looks like in the following screenshot:


		[![Linting](../images/linting/problems_panel.jpg)]()

		Linting works different in [Legacy Mode](legacy_mode/linting.md) and [RLS Mode](rls_mode/linting.md).

		@@ -13,6 +13,10 @@ The extension can function in one of two modes:

		Each mode is described in detail on its own page.

		Furthermore, the extension provides:


		You can see diagnostics in the Problems Panel.

		You can hover on a diagnostics to see what the diagnostic is.


		[![Linting](../images/linting/code.jpg)]()

		Also it populates the Problems panel.


		[![Linting](../../images/linting/code.jpg)]()

		* In the Problems panel:


		[![Linting](../../images/linting/problems_panel_legacy_mode.jpg)]()

		We can hover any diagnostic to see what it is:

		@@ -0,0 +1,27 @@
		# Legacy Mode Linting Page

		Executing a cargo command makes the extension parse the output of the executed command and show diagnostics.

		@@ -0,0 +1,15 @@
		# RLS Mode Linting Page

		`RLS` checks the project and shows diagnostics while you are typing.


		You can hover on a diagnostics to see what the diagnostic is.

		Executing a cargo command doesn't show any diagnostics.


		Executing a cargo command doesn't show any diagnostics.

		It is intentional decision.


		The reason is that there is no pretty way to hide a diagnostic after the diagnostic's cause is fixed.

		It may confuse people.

Added linting to the documentation. #92

Added linting to the documentation. #92

Conversation

KalitaAlexey commented Feb 18, 2017 • edited Loading

redactedscribe Feb 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

redactedscribe Feb 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

redactedscribe Feb 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

redactedscribe Feb 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

redactedscribe Feb 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

redactedscribe Feb 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

redactedscribe Feb 19, 2017 • edited Loading

Choose a reason for hiding this comment

redactedscribe commented Feb 19, 2017

KalitaAlexey commented Feb 19, 2017

redactedscribe commented Feb 19, 2017 • edited Loading

KalitaAlexey commented Feb 19, 2017

KalitaAlexey commented Feb 19, 2017 • edited Loading

KalitaAlexey commented Feb 18, 2017 •

edited

Loading

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe Feb 19, 2017 •

edited

Loading

redactedscribe commented Feb 19, 2017 •

edited

Loading

KalitaAlexey commented Feb 19, 2017 •

edited

Loading