Skip to content

Commit d3ec2c5

Browse files
xperiandriknocte
authored andcommitted
docs,README.md: improve wording [no ci]
See #692
1 parent 9e1786d commit d3ec2c5

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# FSharpLint [![GitHub Actions Build Status](https://github.com/fsprojects/FSharpLint/workflows/CI/badge.svg)](https://github.com/fsprojects/FSharpLint/actions?query=branch%3Amaster)
22

3-
FSharpLint is a static analysis tool for F#. Like many other software linters, it analyzes your source code (via typed and untyped syntax trees), and then it points out locations where a set of rules on how F# is to be styled have been broken. There are various kinds of rules:
3+
FSharpLint is a static analysis tool for F#. Like many other software linters, it analyzes your source code (using both typed and untyped syntax trees) and highlights any violations of defined F# coding rules. There are various kinds of rules:
44

5-
* Conventions: name your public or private API/ABI members to respect project or solution-wide conventions.
6-
* Smells: get warned on logic that might pose maintainability problems or potential downsides.
7-
* Formatting: indent and structure your code to follow a specific set of cosmetic standards.
5+
* **Conventions:** ensures that your API members follow project- or solution-wide naming conventions.
6+
* **Smells:** warns about logic that may pose maintainability problems or potential downsides.
7+
* **Formatting:** checks that code is indented and structured according to specified cosmetic standards.
88

9-
The tool is configurable via JSON and can be run from a console app, or as an MSBuild task. It also provides an interface to easily integrate the tool into other software.
9+
The tool is configurable via JSON and can be run as a console app or as an MSBuild task. It also provides an interface for easy integration into other software.
1010

1111
The project aims to let the user know of problems through [matching user defined hints](https://fsprojects.github.io/FSharpLint/how-tos/rules/FL0065.html) a la [HLint](http://community.haskell.org/~ndm/hlint/), and also by using custom rules written in F# similar to the rules in [Mascot](http://mascot.x9c.fr/manual.html) and [StyleCop](https://github.com/StyleCop/StyleCop).
1212

docs/content/index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,13 @@ menu_order: 1
66

77
# Overview
88

9-
FSharpLint is a static analysis tool for F#. Like many other software linters, it analyzes your source code (via typed and untyped syntax trees), and then it points out locations where a set of rules on how
10-
F# is to be styled have been broken. There are various kinds of rules:
9+
FSharpLint is a static analysis tool for F#. Like many other software linters, it analyzes your source code (using both typed and untyped syntax trees) and highlights any violations of defined F# coding rules. There are various kinds of rules:
1110

12-
* Conventions: name your public or private API/ABI members to respect project or solution-wide conventions.
13-
* Smells: get warned on logic that might pose maintainability problems or potential downsides.
14-
* Formatting: indent and structure your code to follow a specific set of cosmetic standards.
11+
* **Conventions:** ensures that your API members follow project- or solution-wide naming conventions.
12+
* **Smells:** warns about logic that may pose maintainability problems or potential downsides.
13+
* **Formatting:** checks that code is indented and structured according to specified cosmetic standards.
1514

16-
The tool is configurable via JSON and can be run from a console app, or as an MSBuild task. It also provides an interface to easily integrate the tool into other software.
15+
The tool is configurable via JSON and can be run as a console app or as an MSBuild task. It also provides an interface for easy integration into other software.
1716

1817
The project aims to let the user know of problems through [matching user defined hints](./how-tos/rules/FL0065.html)
1918
a la [HLint](http://community.haskell.org/~ndm/hlint/), and also by using custom rules written in F# similar to the rules

0 commit comments

Comments
 (0)