Skip to content

Commit

Permalink
docs: typos, fixes (#270)
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikaverpil authored Jan 19, 2025
1 parent eb9b66f commit d11868e
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Enable support for [testify](https://github.com/stretchr/testify) suites.

!!! note "Subtests not supported"

Right now, nested tests and table tests are not supported. All of this can be
Right now, nested tests and table tests are not supported for testify suites. All of this can be
remedied at any time by extending the treesitter queries. Feel free to dig in
and open a PR!

Expand Down
11 changes: 10 additions & 1 deletion docs/contrib.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ icon: material/heart-multiple-outline

# Contributing

## 🙏 PRs are welcome
## Contributions are welcome

Improvement suggestion PRs to this repo are very much welcome, and I encourage
you to begin by reading the below paragraph on the adapter design and engage in
Expand Down Expand Up @@ -37,6 +37,15 @@ query and play around. You can paste in queries from
in the editor, to see how the query behaves and highlights parts of your Go test
file.

## Previewing the documentation

Intall uv with e.g. `brew install` or `pip install uv`. Then run `uv sync` in
the project root to create a virtual environment and install dependencies into
it.

Finally, run `uv run mkdocs serve` to serve the documentation and preview it on
`http://localhost:8000`.

## General design of the adapter

### Treesitter queries detect tests
Expand Down
15 changes: 8 additions & 7 deletions docs/trouble.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,16 @@ There are many reasons why this can happen:
requires CGO but you don't have `gcc` installed. Read more about this in the
[`go_test_args`](config.md#go_test_args) option description.
- You are on a system which writes non-UTF8 characters to stdout (in which case
you can look into [`gotestsum`](config.md#gotestsum) and/or
you can look into [`gotestsum` runner](config.md#runner) and/or
[`sanitize_output`](config.md#sanitize_output)). This has been reported to
happen in some specific cases:
- When on Windows:
[issues/147](https://github.com/fredrikaverpil/neotest-golang/issues/147)
- When using Ubuntu snaps:
[discussions/161](https://github.com/fredrikaverpil/neotest-golang/discussions/161)
- When using the mongodb test-container:
[discussions/256](https://github.com/fredrikaverpil/neotest-golang/discussions/256)

- When on Windows:
[issues/147](https://github.com/fredrikaverpil/neotest-golang/issues/147)
- When using Ubuntu snaps:
[discussions/161](https://github.com/fredrikaverpil/neotest-golang/discussions/161)
- When using the mongodb test-container:
[discussions/256](https://github.com/fredrikaverpil/neotest-golang/discussions/256)

## Neotest is slowing down Neovim

Expand Down

0 comments on commit d11868e

Please sign in to comment.