Skip to content

Commit 1d06069

Browse files
authored
Merge pull request #2410 from kraigb/kraigb-feedback
Edit most instances of "linting"
2 parents 0b2f505 + 873bb0f commit 1d06069

7 files changed

+29
-29
lines changed

docs/python/editing-python-code-in-visual-studio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,4 +219,4 @@ Double-clicking any name, or selecting with arrow keys and Enter, navigates to t
219219

220220
- [Formatting](formatting-python-code.md)
221221
- [Refactoring](refactoring-python-code.md)
222-
- [Linting](linting-python-code.md)
222+
- [Use a linter](linting-python-code.md)

docs/python/linting-python-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Using PyLint for linting Python code
2+
title: Using PyLint to lint Python code
33
description: How to use PyLint in Visual Studio to check issues in Python code.
44
ms.date: 06/26/2018
55
ms.prod: visual-studio-dev15

docs/python/overview-of-python-tools-for-visual-studio.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,17 @@ For more information:
4242

4343
## Rich editing, IntelliSense, and code comprehension
4444

45-
Visual Studio provides a first-class Python editor, including syntax coloring, auto-complete across all your code and libraries, code formatting, signature help, refactoring, linting (shown below), and type hints. Visual Studio also provides unique features like class view, Go to Definition, Find All References, and code snippets. Direct integration with the [Interactive Window](#interactive-window) helps you quickly develop Python code that's already saved in a file.
45+
Visual Studio provides a first-class Python editor, including syntax coloring, auto-complete across all your code and libraries, code formatting, signature help, refactoring, linting, and type hints. Visual Studio also provides unique features like class view, Go to Definition, Find All References, and code snippets. Direct integration with the [Interactive Window](#interactive-window) helps you quickly develop Python code that's already saved in a file.
4646

4747
![Code completions for Python code in Visual Studio](media/code-editing-completions-simple.png)
4848

4949
For more information:
5050

5151
- Video (2m 30s): [Editing Python code](https://mva.microsoft.com/en-US/training-courses/python-tools-for-visual-studio-2017-18121?l=r2iQH5LWE_4605918567)
52-
- Docs: [Editing Python code](editing-python-code-in-visual-studio.md)
53-
- Docs: [Code formatting](formatting-python-code.md)
54-
- Docs: [Refactoring](refactoring-python-code.md)
55-
- Docs: [Linting](linting-python-code.md)
52+
- Docs: [Edit Python code](editing-python-code-in-visual-studio.md)
53+
- Docs: [Format code](formatting-python-code.md)
54+
- Docs: [Refactor code](refactoring-python-code.md)
55+
- Docs: [Use a linter](linting-python-code.md)
5656
- General Visual Studio feature docs: [Features of the code editor](../ide/writing-code-in-the-code-and-text-editor.md)
5757

5858
## Interactive Window

docs/python/toc.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,16 +88,16 @@
8888
href: search-paths.md
8989
- name: Environment window reference
9090
href: python-environments-window-tab-reference.md
91-
- name: Editing code
91+
- name: Edit Python code
9292
href: editing-python-code-in-visual-studio.md
9393
items:
94-
- name: Formatting code
94+
- name: Format code
9595
href: formatting-python-code.md
96-
- name: Refactoring code
96+
- name: Refactor code
9797
href: refactoring-python-code.md
98-
- name: Using PyLint
98+
- name: Use PyLint
9999
href: linting-python-code.md
100-
- name: Defining custom menu commands
100+
- name: Define custom menu commands
101101
href: defining-custom-python-project-commands.md
102102
- name: Interactive Python (REPL)
103103
href: python-interactive-repl-in-visual-studio.md

docs/python/tutorial-working-with-python-in-visual-studio-step-02-writing-code.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Although Solution Explorer is where you manage project files, the *editor* windo
8888

8989
## Go deeper
9090

91-
- [Editing code](editing-python-code-in-visual-studio.md)
92-
- [Formatting code](formatting-python-code.md)
93-
- [Refactoring code](refactoring-python-code.md)
94-
- [Using PyLint](linting-python-code.md)
91+
- [Edit code](editing-python-code-in-visual-studio.md)
92+
- [Format code](formatting-python-code.md)
93+
- [Refactor code](refactoring-python-code.md)
94+
- [Use PyLint](linting-python-code.md)

docs/rtvs/linting-r-code.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Linting R code
3-
description: How to work with Visual Studio's build-in linting support for R, including linting options.
3+
description: How to work with Visual Studio's build-in linting support for R, including linter options.
44
ms.date: 01/15/2018
55
ms.prod: visual-studio-dev15
66
ms.technology: vs-rtvs
@@ -14,31 +14,31 @@ ms.workload:
1414
- data-science
1515
---
1616

17-
# Linting R code in Visual Studio
17+
# Lint R code in Visual Studio
1818

19-
Linting analyzes code to reveal potential errors, formatting issues, and other code noise such as spurious whitespace. Linting also helps encourage certain coding conventions, such as how identifiers are named. Such conventions are helpful within teams and other collaborative situations.
19+
A linter analyzes code to reveal potential errors, formatting issues, and other code noise such as spurious whitespace. Using a linter also helps encourage certain coding conventions, such as how identifiers are named. Such conventions are helpful within teams and other collaborative situations.
2020

21-
R Tools for Visual Studio (RTVS) provides built-in linting for R, the behavior of which is controlled through a variety of options described in this article. These options are found in **Tool > Options > Text Editor > R > Lint**.
21+
R Tools for Visual Studio (RTVS) provides a built-in linter for R, the behavior of which is controlled through a variety of options described in this article. These options are found in **Tool > Options > Text Editor > R > Lint**.
2222

23-
Linting is disabled by default. To enable linting, set the **All > Enable lint** option to true.
23+
The lint is disabled by default. To enable the lint, set the **All > Enable lint** option to true.
2424

25-
When enabled, linting is applied in the editor while you type. Issues appear as green squiggles. In the following graphic, for example, RTVS has identified six linting issues, including use of `=` instead of `<-` for an assignment, lack of spacing around function arguments, use of Pascal case and uppercase identifiers, and use of a semicolon. Hovering over an issue provides a description.
25+
When enabled, the linter run in the editor while you type. Issues appear as green squiggles. In the following graphic, for example, RTVS has identified six lint issues, including use of `=` instead of `<-` for an assignment, lack of spacing around function arguments, use of Pascal case and uppercase identifiers, and use of a semicolon. Hovering over an issue provides a description.
2626

27-
![Examples of linting for R code](media/linting-01.png)
27+
![Examples of linter output for R code](media/linting-01.png)
2828

29-
You often change linting options depending on the needs of a project or file. For example, sample code from an online course might use `=` instead of `<-` along with Pascal-case identifiers. Such code would show frequent linting warnings because the default linting options flag these cases. While working with that code, then, you can disable the options instead of spending time correcting each instance.
29+
You often change linter options depending on the needs of a project or file. For example, sample code from an online course might use `=` instead of `<-` along with Pascal-case identifiers. Such code would show frequent linter warnings because the default linter options flag these cases. While working with that code, then, you can disable the options instead of spending time correcting each instance.
3030

3131
## Assignment group
3232

33-
| Option | Default value | Linting effect |
33+
| Option | Default value | Lint effect |
3434
| --- | --- | --- |
3535
| Enforce \<- | `True` | Identifies when `<-` isn't used for assignment. |
3636

3737
## Naming group
3838

3939
These options flag identifiers that use different naming conventions:
4040

41-
| Option | Default value | Linting effect |
41+
| Option | Default value | Lint effect |
4242
| --- | --- | --- |
4343
| Flag camelCase | `False` | Flags identifiers that use camelCase. |
4444
| Flag long names | `False` | Flags identifiers whose named exceed the "Max name length" setting. |
@@ -54,14 +54,14 @@ These options, all of which are set to `True` by default, control where the lint
5454

5555
## Statements group
5656

57-
| Option | Default value | Linting effect |
57+
| Option | Default value | Lint effect |
5858
| --- | --- | --- |
5959
| Multiple | `True` | Identifies when multiple statements are on the same line. |
6060
| Semicolons | `True` | Identifies uses of semicolons. |
6161

6262
## Text group
6363

64-
| Option | Default value | Linting effect |
64+
| Option | Default value | Lint effect |
6565
| --- | --- | --- |
6666
| Line length limit | `False` | Sets whether the linter flags lines longer than the "Max line length" option. |
6767
| Max line length | 80 | Sets the line length applied by the "Line length limit" option. |

docs/rtvs/options-for-r-tools-in-visual-studio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Settings are accessed through the **R Tools** > **Options** menu, or through **T
2626
Options and settings specific to R are accessed using the methods below. You must select the **Show all settings** box at the bottom of the **Options** dialog box for all of these sections to appear.
2727

2828
- Code formatting options (see [Editor options](editing-r-code-in-visual-studio.md#editor-options): **Tools** > **Options** menu, then select **Text Editor** > **R** > **Formatting**
29-
- Linting options (see [Linting](linting-r-code.md)): **Tools** > **Options** menu, then select **Text Editor** > **R** > **Lint**
29+
- Linter options (see [Linting](linting-r-code.md)): **Tools** > **Options** menu, then select **Text Editor** > **R** > **Lint**
3030
- Advanced editor options ([described in this article](#text-editor--r--advanced-options)): **Tools** > **Options** menu, then select **Text Editor** > **R** > **Advanced**
3131
- Behavioral options ([described in this article](#r-tools--advanced-options)): **R Tools** > **Options** menu, or **Tools** > **Options**, then scroll to **R Tools**.
3232

0 commit comments

Comments
 (0)