Skip to content

[Draft: Has to wait until all of the above are merged] docs: Fix typos and spelling errors, add cspell #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 34 commits into
base: master
Choose a base branch
from
Draft

[Draft: Has to wait until all of the above are merged] docs: Fix typos and spelling errors, add cspell #151

wants to merge 34 commits into from

Conversation

bernhardkaindl
Copy link
Contributor

@bernhardkaindl bernhardkaindl commented Nov 15, 2024 •
edited
Loading

Topic: Fix GitHub CI

In this PR:

  • Fix typos and spelling issues.

Contents:

  • Commits 23-27 from CI PR #8: Fix pre-commit checks #150: (please review)

    • pre-commit config: Fix check: python-check-blanket-type-ignore
    • .pre-commit-config.yaml: Fix pre-commit config: pytest, mypy & pylint
    • .github/workflows/main.yml: Add CI job for running pre-commit
    • pre-commit: Fix warning about deprecated hook config: Update hooks
    • .pre-commit-config.yaml: Fix pre-commit configuration for pytype

  • Commits 28-34 from this PR:

    • README.md: Fix typos and spelling errors
    • CONTRIBUTING.md: Fix typos and spelling errors
    • README-Unicode.md: Fix typos and spelling errors
    • Fix typos in code comments, simplify them
    • pylint,pytype wrappers: Fix spell check on short variable names
    • unit tests: Fix spell check for the unit tests
    • .pre-commit-config.yaml: Add the CSpell spell checker

@bernhardkaindl
Fix GitHub CI and 'tox' for local CI on Ubuntu 24.04
16ed521 
- It has become impractical to use EOL versions like Python 3.6 in CI
- It has become counterproductive to use pyre CI, disable it for now.
- Move forward to run the unit tests with Python 3.11

Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
Add checks to compensate code coverage
efe4efb 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
Cover the code handing a 2nd call of accessor.finish()
0c94f63 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
Fix first half of the pyright warnings in unit tests
32aceac 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
Fix pylint and 2nd half of the pyright warnings in unit tests
d1504af 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
pyright: Bump Python version to check for to 3.11
e28224e 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
pyright: Fix ErrorHandler taking Response | None
b1c5365 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
pyright: Skip warning on renamed arg: FTPAccessor.access(name->path)
e52d72e 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
tox.ini: Complete the transition from pyre to pyright
b5fb04a 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
pre-commit: Remove the remaining call to pyre in pre-commit
cb947a6 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
docs: Complete the transition from pyre to pyright
96a73d3 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
tox.ini/pyright: Fail tox if pyright fails (enforce check)
c1ebd7b 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
pyre: Finally, remove obsolete pyre error suppressions
88ad644 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
GitHub CI/tox: Update CI to use Python 3.11, 3.12 and 3.13
6357af6 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
test_bootloader.py/pylint: assertRegexpMatches renamed to assertR…
ab21598 
…egex

Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
CONTRIBUTING.md: Add venv setup and using pipx
e30a79d 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
tests/test_logger.py: Use pyfakefs: don't create a file in the host
f1b4826 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
.github/workflows/main.yml: Cleanup obsolete code for Python 2.7/3.8
fc28eb1 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
CONTRIBUTING.md: Fix Markdown format for linting
5c544ac 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
README.md: Fix Markdown format for linting and update it
ae2bb8e 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
README-Unicode.md: Fix Markdown format for linting and update it
554e648 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
.pre-commit-config.yaml: Replace mdformat check with markdownlint-cli
70d84ba 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
pre-commit config: Fix check: python-check-blanket-type-ignore
45a9833 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
.pre-commit-config.yaml: Fix pre-commit config: pytest, mypy & pylint
0630f1f 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
.github/workflows/main.yml: Add CI job for running pre-commit
63b45d8 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
pre-commit: Fix warning about deprecated hook config: Update hooks
bbce126 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
.pre-commit-config.yaml: Fix pre-commit configuration for pytype
393cf4c 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
README.md: Fix typos and spelling errors
b99fe6e 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
README-Unicode.md: Fix typos and spelling errors
7c67c2c 
Signed-off-by: Bernhard Kaindl <[email protected]>
@bernhardkaindl
CONTRIBUTING.md: Fix typos and spelling errors
2802010 
Signed-off-by: Bernhard Kaindl <[email protected]>
@coveralls
Copy link

coveralls commented Nov 15, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 11866455425

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • 12 unchanged lines in 4 files lost coverage.
  • Overall coverage decreased (-0.009%) to 83.661%
Files with Coverage Reduction New Missed Lines %
xcp/accessor.py 1 89.1%
xcp/xmlunwrap.py 2 92.31%
xcp/cpiofile.py 3 75.26%
xcp/compat.py 6 78.57%
Totals Coverage Status
Change from base Build 9109272969: -0.009%
Covered Lines: 2806
Relevant Lines: 3354
💛 - Coveralls

@bernhardkaindl bernhardkaindl mentioned this pull request Nov 16, 2024
Closed
@freddy77
Copy link
Contributor

It looks like this PR is out of date and needs rebase.

@bernhardkaindl bernhardkaindl marked this pull request as draft August 26, 2025 22:13
@bernhardkaindl bernhardkaindl changed the title CI PR #9: docs: Fix typos and spelling errors, add cspell [Draft: Has to wait until all of the above are merged] docs: Fix typos and spelling errors, add cspell Aug 26, 2025
@bernhardkaindl bernhardkaindl mentioned this pull request Aug 26, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bernhardkaindl @coveralls @freddy77