Skip to content
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.

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

docs: touchups #114

Merged
merged 1 commit into from
Jul 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Reliable Neotest adapter for running Go tests in Neovim.
## ⭐️ Features

- Supports all [Neotest usage](https://github.com/nvim-neotest/neotest#usage).
- Supports table tests and nested test functions (based on AST/tree-sitter
detection).
- Supports table tests and nested test functions (based on treesitter AST
parsing).
- DAP support with [leoluz/nvim-dap-go](https://github.com/leoluz/nvim-dap-go)
integration for debugging of tests using
[delve](https://github.com/go-delve/delve).
Expand Down Expand Up @@ -361,8 +361,8 @@ more information on this.

> [!WARNING]
> This feature comes with some caveats and nuances, which is why it
> is not enabled by default. I respectfully advise you to only enable this if
> you really need it.
> is not enabled by default. I advise you to only enable this if
> you need it.

There are some real shenaningans going on behind the scenes to make this work.
First, a lookup of "receiver type-to-suite test function" must be created of all
Expand All @@ -375,8 +375,8 @@ feature...
> Right now, there is no way to update the lookup other than restarting
> Neotest/Neovim. So in case you are implementing a new suite, please restart to
> see the new suites/tests appear in e.g. the summary window. Also, nested tests
> or table tests are not supported, but can be added at any time. Feel free to
> open a PR!
> or table tests are not supported. All of this can be remedied at any time.
> Feel free to dig in and open a PR!

## 🙏 PRs are welcome

Expand Down
Loading