Skip to content

Commit

Permalink
Merge pull request #4174 from Aster89/typos
Browse files Browse the repository at this point in the history
Fix typos in readme
  • Loading branch information
mergify[bot] authored Aug 19, 2023
2 parents 18fa0f4 + def83f9 commit e949df3
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ To run locally, you have to be on MacOS or Linux. Sorry, Windows testing is
not supported. However, there is a [docker image](#running-the-tests-in-docker)
in which you can run the tests.

* Ensure you have at least the Vim vresion in YCM_VIM_VERSION (in
* Ensure you have at least the Vim version in YCM_VIM_VERSION (in
`test/docker/ci/image/Dockerfile`)
* Ensure ycmd is compiled ***with python3*** and clangd is enabled
`python3 install.py --ts-completer --clangd-completer --java-completer`
* Install the test python deps (`pip install -r python/test_requirements.txt`)
* Run `./test/run_vim_tests`

## Runniing the tests in Windows (WSL)
## Running the tests in Windows (WSL)

NOTE: This environment isn't officially supported, and the preferred mechanism to run the tests is to use docker.

Expand Down Expand Up @@ -161,21 +161,21 @@ YCM's `ycm_state` object knows about.
# The test plugin

The "plugin" provides a handful of things, some of which were simply ported from
Vim's test framework, and some were writted specifically for YCM.
Vim's test framework, and some were written specifically for YCM.

## Ported from Vim

These are general purpose functions which are commonly used:

* `WaitForAssert`: This one is the most useful. It takes a callable (usually a
lambda) and waits for it to return 0, but allows the Vim event loop to run in
betwen calls. This is key to ensuring that the YCM code can execute while the
between calls. This is key to ensuring that the YCM code can execute while the
script is actively trying to test it. **NOTE**: It waits for the _function to
return 0_, **NOT** for the assert to be true/v:errors to be empty!

## YCM-specific

The autoload functions perform some useful common YCM-sepcific stuff such as
The autoload functions perform some useful common YCM-specific stuff such as
setup and teardown, and will likely be built out over time as the suite
increases in size and complexity.

Expand Down Expand Up @@ -225,7 +225,7 @@ Things that you need to know to write tests effectively:

`run_vim_tests` takes arguments of the form `<test script>:<test function filter>`.

For eample to just run the "MyOtherTest" test in the `mytests.test.vim`:
For example to just run the "MyOtherTest" test in the `mytests.test.vim`:

```
$ run_vim_tests mytests.test.vim:MyOtherTest
Expand Down

0 comments on commit e949df3

Please sign in to comment.