Skip to content

Commit

Permalink
feat(docs): small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
shivay-at-pieces committed Aug 30, 2024
1 parent e080d76 commit a73f874
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/extensions-plugins/neovim/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ A few things to note before you start installing the Pieces Neovim Plugin:
- The Python based Neovim plugins requires the `pynvim` Python package, which is not included in the default Neovim installation. You can install it by running the following command:

```bash
pip install pynvim
pip3 install pynvim
```

- Ensure that you have at least one Neovim package manager installed. For instance, you can install `vim-plug`.
Expand All @@ -47,11 +47,14 @@ A few things to note before you start installing the Pieces Neovim Plugin:
touch ~/.config/nvim/init.vim
```
Note: Your Neovim configuration file can either be `init.vim` or `init.lua`. If you are using `init.lua`, you will need to add the following line to your configuration file:
:::info
Note: Your Neovim configuration file can either be `init.vim` or `init.lua`. If you are using `init.lua`, you will need to add the following line to your configuration file:
```lua
vim.cmd [[packadd pieces.nvim]]
```
```lua
vim.cmd [[packadd pieces.nvim]]
```
:::
## Steps
Expand Down
12 changes: 12 additions & 0 deletions docs/extensions-plugins/neovim/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@ Ensure that you have installed the `pynvim` package. You can do this by running
pip install pynvim
```

### Issue with support for Python Version 3.12

#### Problem

When attempting to run the Neovim plugin with Python version 3.12 you may encounter the following error: `TypeError: ForwardRef._evaluate() missing 1 required keyword-only argument: 'recursive_guard'`.

This is a known issue in Python 3.12 and this error occurs due to changes in the Python 3.12 implementation that affect how forward references are evaluated, causing compatibility issues with the plugin's code.

#### Solution

The most straightforward solution for now is to use Python 3.11 or earlier. You can switch to an earlier version using a version manager like pyenv. We recommend to regularly check the Pieces Neovim Plugin repository for updates that may address this compatibility issue.

## Contact Support

If you continue to experience issues after trying our solutions, please to [reach out to our support team](/support) for further assistance.

0 comments on commit a73f874

Please sign in to comment.