Skip to content

Commit a106031

Browse files
committed
General fixes on documentation
1 parent 14a65b9 commit a106031

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ cnes-pylint-extension checks the following rules :
1818

1919
cnes-pylint-extension checks the following metrics :
2020
- R5301 - too-high-complexity (default < 25)
21-
- R5302 - too-high-complexity-simplified (defailt < 20)
21+
- R5302 - too-high-complexity-simplified (default < 20)
2222
- R5201 - too-few-comments (default > 20%)
2323

2424
# Available versions :
@@ -30,11 +30,16 @@ cnes-pylint-extension checks the following metrics :
3030

3131
# To use these checkers:
3232

33-
## Install Pylint
33+
## Install from PIP
34+
`pip install cnes-pylint-extension`
35+
36+
## Install from sources
37+
38+
### Install Pylint
3439

3540
`pip install pylint==2.5.0`
3641

37-
## Install CNES Pylint extension checkers
42+
### Install CNES Pylint extension checkers
3843

3944
Download the project's code source then add the checkers subdirectory to your PYTHONPATH :
4045

@@ -52,6 +57,8 @@ load-plugins=cnes_checker
5257
...
5358
```
5459

60+
## Usage
61+
5562
Pylint is now able to use the extension.
5663

5764
Otherwise, add `--load-plugins=cnes_checker` to your pylint command line in order to activate it.

setup.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
name="cnes-pylint-extension",
88
version="5.0.0",
99
author="CNES CatLab",
10-
description="A PyLint plugin that can output to SonarQube-importable JSON",
10+
description="A PyLint plugin to add coding CNES specific checks",
1111
long_description=long_description,
1212
long_description_content_type="text/markdown",
1313
url="https://github.com/cnescatlab/cnes-pylint-extension",
@@ -16,12 +16,15 @@
1616
license_file='LICENSE',
1717
classifiers=[
1818
"Programming Language :: Python :: 3",
19-
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
19+
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
2020
"Operating System :: OS Independent",
2121
],
2222
python_requires='>=3.6',
2323
install_requires=[
2424
"pylint-plugin-utils==0.7",
2525
"pylint==2.5.0"
2626
],
27+
project_urls={
28+
'Bug Reports': 'https://github.com/cnescatlab/cnes-pylint-extension/issues'
29+
}
2730
)

0 commit comments

Comments
 (0)