Skip to content

Commit 642db8e

Browse files
authored
Update docs and images (#57)
* Update docs and images * Update display size
1 parent fba6075 commit 642db8e

9 files changed

+14
-10
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676

7777
#### `version`
7878

79-
- **Description**: The desired version of the [clang-tools](https://hub.docker.com/repository/docker/xianpengshen/clang-tools) to use. Accepted options are strings which can be 14, 13, 12, 11, 10, 9, or 8.
79+
- **Description**: The desired version of the [clang-tools](https://hub.docker.com/r/xianpengshen/clang-tools) to use. Accepted options are strings which can be 14, 13, 12, 11, 10, 9, or 8.
8080
- Default: '10'
8181

8282
#### `verbosity`
@@ -183,13 +183,15 @@ All input options listed above are specified by pre-pending a `--`. You can also
183183

184184
<!--intro-end-->
185185

186-
### Thread Comment
186+
### Annotations
187187

188-
![github-actions bot](./docs/images/demo_comment.png)
188+
<a href="url"><img src="./docs/images/annotations-clang-format.png" height="408" width="744" ></a>
189189

190-
### Annotations
190+
<a href="url"><img src="./docs/images/annotations-clang-tidy.png" height="446" width="547" ></a>
191+
192+
### Thread Comment
191193

192-
![workflow annotations](./docs/images/demo_annotations.png)
194+
<a href="url"><img src="./docs/images/comment.png" height="975" width="831" ></a>
193195

194196
<!--footer-start-->
195197

19.9 KB
Loading
23.9 KB
Loading

docs/images/comment.png

48.7 KB
Loading

docs/images/demo_annotations.png

-23.9 KB
Binary file not shown.

docs/images/demo_comment.png

-25.4 KB
Binary file not shown.

docs/images/result.png

-53.5 KB
Binary file not shown.

docs/index.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@
88
end="<!--intro-end-->"
99
%}
1010

11-
### Thread Comment
11+
### Annotations
1212

13-
![sample comment](images/demo_comment.png)
13+
![clang-format annotations](images/annotations-clang-format.png)
1414

15-
### Annotations
15+
![clang-tidy annotations](images/annotations-clang-tidy.png)
16+
17+
### Thread Comment
1618

17-
![workflow annotations](images/demo_annotations.png)
19+
![sample comment](images/comment.png)
1820

1921
{%
2022
include-markdown "../README.md"

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"A python package that powers the github action named cpp-linter-action. "
2020
+ f"See `the github repository README <{REPO}#readme>`_ for full details."
2121
),
22-
author="Brendan Doherty, Peter Shen",
22+
author="Brendan Doherty",
2323
author_email="[email protected]",
2424
install_requires=["requests", "pyyaml"], # pyyaml is installed with clang-tidy
2525
license="MIT",

0 commit comments

Comments
 (0)