Skip to content

Commit 90d27db

Browse files
authored
doc: typo and formatting fixes (#1619)
* Update CONTRIBUTING.md Small typos and changes for readability. * Update README.md Fix link to Github CI
1 parent fd93c54 commit 90d27db

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ One of the reasons we suggest virtualenv is that it makes it easier to do this s
127127

128128
If you want to run a local copy of cve-bin-tool, the recommended way is to install it locally. From the cve-bin-tool main directory, run:
129129

130-
```console
130+
```bash
131131
python3 -m pip install --user -e .
132132
```
133133

@@ -254,7 +254,7 @@ git checkout -b my_new_branch
254254
```
255255

256256
>Note: If you accidentally check something in to main and want to reset it to match our main branch, you can save your work using `checkout -b` and then do a `git reset` to fix it:
257-
>```
257+
>```bash
258258
>git checkout -b saved_branch
259259
>git reset --hard origin/main
260260
>```
@@ -321,7 +321,7 @@ Most of our "style" stuff is caught by the `black` and `flake8` linters, but we
321321
322322
### String Formatting
323323
324-
Python provides many different ways to format the string(you can read about them [here](https://realpython.com/python-formatted-output/))and we use f-string formatting in our tool.
324+
Python provides many different ways to format the string (you can read about them [here](https://realpython.com/python-formatted-output/)) and we use f-string formatting in our tool.
325325
326326
> Note: f-strings are only supported in python 3.6+.
327327
@@ -337,7 +337,7 @@ print(f"Name of the person is {name} and his age is {age}")
337337
# "Name of the person is John Doe and his age is 23"
338338
```
339339
340-
Note that the string started with the **'f'** followed by the string. Values are always added in the curly braces. Also we don't need to convert age into string. (we may have used **str(age )** before using it in the string) f-strings are useful as they provide many cool features. You can read more about features and the good practices to use f-strings [here](https://realpython.com/python-f-strings/#f-strings-a-new-and-improved-way-to-format-strings-in-python).
340+
Note that the string started with the `f` followed by the string. Values are always added in the curly braces. Also we don't need to convert age into string. (we may have used `str(age)` before using it in the string) f-strings are useful as they provide many cool features. You can read more about features and the good practices to use f-strings [here](https://realpython.com/python-f-strings/#f-strings-a-new-and-improved-way-to-format-strings-in-python).
341341
342342
## Making documentation
343343

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ compiler above should fix it.
296296

297297
`pdftotext` is required for running tests. (users of cve-bin-tool may not need it, developers likely will.) The best approach to install it on Windows involves using [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/windows.html) (click [here](https://anaconda.org/conda-forge/pdftotext) for further instructions).
298298

299-
You can check [our CI configuration](https://github.com/intel/cve-bin-tool/blob/main/.github/workflows/pythonapp.yml) to see what versions of python we're explicitly testing.
299+
You can check [our CI configuration](https://github.com/intel/cve-bin-tool/blob/main/.github/workflows/testing.yml) to see what versions of python we're explicitly testing.
300300

301301
## Feedback & Contributions
302302

0 commit comments

Comments
 (0)