Skip to content

docs: use concrete path instead of stdpath reference #1

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

Merged
wassimk merged 1 commit into from
Feb 21, 2026
Merged

docs: use concrete path instead of stdpath reference #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Add `git_coauthors` to your nvim-cmp sources for the gitcommit filetype.
2. Type `@` to trigger handle completion
3. Select a handle to insert the full `Name <email>`

Handles are loaded from a JSON file at `vim.fn.stdpath('data') .. '/git-coauthors/handles.json'`:
Handles are loaded from a JSON file at `~/.local/share/nvim/git-coauthors/handles.json`:

```json
{
Expand Down Expand Up @@ -90,7 +90,7 @@ require('git-coauthors').setup({

| Option | Default | Description |
| --- | --- | --- |
| `handles_path` | `stdpath('data') .. '/git-coauthors/handles.json'` | Path to the JSON handles file |
| `handles_path` | `~/.local/share/nvim/git-coauthors/handles.json` | Path to the JSON handles file |
| `handles` | `nil` | Inline handles (merged over file, inline wins on duplicates) |

## Snippet
Expand Down
22 changes: 11 additions & 11 deletions doc/git-coauthors.nvim.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ USAGE *git-coauthors.nvim-git-coauthors.nvim-usage*
2. Type `@` to trigger handle completion
3. Select a handle to insert the full `Name <email>`

Handles are loaded from a JSON file at `vim.fn.stdpath('data') ..
'/git-coauthors/handles.json'`:
Handles are loaded from a JSON file at
`~/.local/share/nvim/git-coauthors/handles.json`:

>json
{
Expand Down Expand Up @@ -110,16 +110,16 @@ Pass options via blink.cmp’s provider `opts` or
})
<

--------------------------------------------------------------------------------------------------
Option Default Description
----------------------- -------------------------------------------------- -----------------------
handles_path stdpath('data') .. '/git-coauthors/handles.json' Path to the JSON
handles file
------------------------------------------------------------------------------------------------
Option Default Description
----------------------- ------------------------------------------------ -----------------------
handles_path ~/.local/share/nvim/git-coauthors/handles.json Path to the JSON
handles file

handles nil Inline handles (merged
over file, inline wins
on duplicates)
--------------------------------------------------------------------------------------------------
handles nil Inline handles (merged
over file, inline wins
on duplicates)
------------------------------------------------------------------------------------------------

SNIPPET *git-coauthors.nvim-git-coauthors.nvim-snippet*

Expand Down