Skip to content

Commit b99fe6e

Browse files
README.md: Fix typos and spelling errors
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
1 parent 393cf4c commit b99fe6e

1 file changed

Lines changed: 15 additions & 18 deletions

File tree

README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![](https://img.shields.io/badge/License-BSD--2--Cause%20%26%20MIT-brightgreen)](https://github.com/xenserver/python-libs/blob/master/LICENSE)
77

88
The `xcp` directory contains the Common XenServer and XCP-ng Python packages.
9-
They are intented for use in XenServer and XCP-ng Dom0 only and deal with logging,
9+
They are for use in XenServer and XCP-ng Dom0 only and deal with logging,
1010
Hardware/PCI, networking, and other Dom0 tasks.
1111

1212
The package name is `python-libs` which is also the `rpm` package name in XenServer.
@@ -23,26 +23,23 @@ Please see [CONTRIBUTING.md] for installing a local development environment.
2323
This package has CI which can be run locally but is also run in GitHub CI to ensure
2424
Test-driven development.
2525

26-
The Continuous Integration Tests feature:
26+
CI features:
2727

2828
- Combined coverage testing of Python 2.7 and Python 3.8 code branches
2929
- Automatic Upload of the combined coverage to CodeCov (from the GitHub Workflow)
3030
- Checking of the combined coverage against the diff to master: Fails if changes are not covered!
31-
- Pylint report in the GitHub Action Summary page, with Warning and Error annotatios, even in the code review.
32-
- Check that changes don't generate pylint warnings (if warning classes which are enabled in .pylintrc)
31+
- Pylint report in the GitHub Action Summary page, with Warning and Error annotations, even in the code review.
32+
- Check that changes don't generate pylint warnings (if warning classes which are enabled in `.pylintrc`)
3333
- Static analysis using `mypy`, `pylint`, `pyright` and `pytype`
3434

3535
This enforces that any change (besides whitespace):
3636

37-
- has code coverage and
37+
- Has code coverage,
3838
- does not introduce a `pylint` warning which is not disabled in `.pylintrc`
3939
- does not introduce a type of static analysis warning which is currently suppressed.
4040

4141
## Status Summary
4242

43-
- The warnings shown on the GitHub Actions Summary Page indicate the remaining
44-
work for full Pyhon3 support (excluding missing tests).
45-
4643
## `Pylint` results from GitHub CI in GitHub Actions page
4744

4845
A step of the GitHub workflow produces a browser-friendly `pylint` report:
@@ -81,19 +78,19 @@ For the installation of the general development dependencies, visit [INSTALL.md]
8178
- Commit with `--signoff` on a new branch and push it and check the triggered GitHub Action run succeeds.
8279
- Open a new PR
8380

84-
The list of `virtualenvs` configured in tox can be shown using this command: `tox -av`
81+
The list of `virtualenvs` configured in `tox` can be shown using this command: `tox -av`
8582

8683
```ml
8784
$ tox -av
8885
default environments:
8986
py36-lint -> Run in a py36 virtualenv: Run pylint and fail on warnings remaining on lines in the diff to master
90-
py311-pyright -> Run in a py311 virtualenv: Run pyright for static analyis
91-
py38-pytype -> Run in a py38 virtualenv: Run pytype for static analyis, intro: https://youtu.be/abvW0mOrDiY
92-
py310-covcombine-check -> Run in a py310 virtualenv: Generate combined coverage reports with py27-test coverage merged Run mypy for static analyis
87+
py311-pyright -> Run in a py311 virtualenv: Run pyright for static analysis
88+
py38-pytype -> Run in a py38 virtualenv: Run pytype for static analysis, intro: https://youtu.be/abvW0mOrDiY
89+
py310-covcombine-check -> Run in a py310 virtualenv: Generate combined coverage reports with py27-test coverage merged Run mypy for static analysis
9390
9491
additional environments:
95-
cov -> Run in a python virtualenv: Generate coverage html reports (incl. diff-cover) for this environment
96-
covcp -> Run in a python virtualenv: Copy the generated .converage and coverage.xml to the UPLOAD_DIR dir
92+
cov -> Run in a python virtualenv: Generate coverage html reports for this environment
93+
covcp -> Run in a python virtualenv: Copy the generated .coverage and coverage.xml to the UPLOAD_DIR dir
9794
fox -> Run in a python virtualenv: Generate combined coverage html reports and open them in firefox
9895
mdreport -> Run in a python virtualenv: Make a test report (which is shown in the GitHub Actions Summary Page)
9996
test -> Run in a python virtualenv: Run pytest in this environment with --cov for use in other stages
@@ -109,8 +106,8 @@ which runs the tests in GitHub CI as well. But of course, because they code is l
109106
still not yet typed, no strict checks can be enabled so far. However, every checker
110107
which is possible now, is enabled.
111108

112-
Checking the contents of untyped functions is enabled for all but four modules which
113-
would need more work. Look for `check_untyped_defs = false` in `pytproject.toml`.
109+
Checking the contents of not typed functions is enabled for all but four modules which
110+
would need more work. Look for `check_untyped_defs = false` in `pyproject.toml`.
114111

115112
The goal or final benefit would be to have it to ensure internal type correctness
116113
and code quality but also to use static analysis to check the interoperability with
@@ -124,7 +121,7 @@ tools like `mypy` and `pyright` (VS Code):
124121

125122
Quoting from <https://stackoverflow.com/questions/53306458/python-3-type-hints-in-python-2>:
126123

127-
> Function annotations were introduced in [PEP 3107](https://www.python.org/dev/peps/pep-3107/) for Python 3.0. The usage of annotations as type hints was formalized in in [PEP 484](https://www.python.org/dev/peps/pep-0484/) for Python 3.5+.
124+
> Function annotations were introduced in [PEP 3107](https://www.python.org/dev/peps/pep-3107/) for Python 3.0. The usage of annotations as type hints was formalized in [PEP 484](https://www.python.org/dev/peps/pep-0484/) for Python 3.5+.
128125
>
129126
> Python < 3.0 does support the type hints syntax, but
130127
> [PEP 484](https://www.python.org/dev/peps/pep-0484/#suggested-syntax-for-python-2-7-and-straddling-code)
@@ -137,7 +134,7 @@ def get_default_device(use_gpu=True):
137134
...
138135
```
139136

140-
Many type checkers support this syntax: mypy, pyright/pylance, pytype
137+
Many type checkers support this syntax: mypy, pyright, pytype
141138

142139
As proof, these examples show how the comment below triggers the checks:
143140

0 commit comments

Comments
 (0)