Skip to content

Commit 6106a9f

Browse files
committed
update readme example
1 parent 4fa81a0 commit 6106a9f

File tree

3 files changed

+25
-6
lines changed

3 files changed

+25
-6
lines changed

.github/workflows/main.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ jobs:
4343
python-version: ${{ matrix.python-version }}
4444
architecture: x64
4545

46-
- name: Setup Package and Install Devel Dependancies
46+
- name: Setup Package and Install Devel Dependencies
4747
run: |
4848
python -m pip install -Ur dev-requirements.txt
4949
python -m pip install .
5050
5151
- name: Unit Tests
52-
run: py.test tests -sqvv
52+
run: py.test -v tests

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,9 @@ linkstatus --help
6363

6464
# Run unit test with nox
6565
```shell
66-
nox -s pre_commit # pre-commit checks
67-
nox -s tests # unit tests
66+
nox --list # list all available sessions
67+
nox -s pre_commit # run pre-commit checks
68+
nox -s tests # run unit tests
6869
```
6970
# Your First Contribution
7071

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,27 @@ Options:
3939
-t, --timeout INTEGER Request timeout (default 4 second)
4040
-rt, --retry INTEGER Retry link status (default 2 time)
4141
--help Show this message and exit.
42-
```
4342
44-
![linkstatus](https://user-images.githubusercontent.com/11618054/67764478-0fcec100-fa70-11e9-9c3c-04c1f432f620.png)
43+
44+
❯❯❯ linkstatus tests/data/markdown_file.md
45+
Links in File: 'tests/data/markdown_file.md'
46+
✓ L4 : https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
47+
✓ L8 : http://www.google.com
48+
✓ L10 : https://www.google.com
49+
✓ L12 : https://github.com/pythonpune/linkstatus
50+
✓ L24 : http://www.example.com
51+
✗ L34 : https://github.com/pythonpune/linkcheck (404)
52+
✓ L39 : https://github.com//pythonpune/
53+
… L41 : http://<hostname>:<port> (skip)
54+
… L43 : https://<hostname>:<port>/pages (skip)
55+
=================================================================================================================
56+
Links Status Summary
57+
Links UP: 6
58+
Links SKIP: 2
59+
Links DOWN: 1
60+
Warning: Use `noqa` inline comment to skip link check. like, response code 403 due to header restrictions etc...
61+
=================================================================================================================
62+
```
4563

4664

4765
**Note: Skip link check for any line by adding `noqa` (no quality assurance) as inline comment

0 commit comments

Comments
 (0)