barrett/pending.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

docs: update forge links for inline overlay rendering

Browse source 
Problem: documentation described forge tokens as stripped from the
description and rendered via EOL `%l` specifier by default.

Solution: update forge links section to describe inline conceal
overlay rendering. Update default `eol_format` reference. Change
`issue_format` field description from "EOL label" to "inline overlay
label".
This commit is contained in:
Barrett Ruth 2026-03-10 18:58:54 -04:00
parent ff280a9c2a
commit 097c76088e
1 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

18
doc/pending.txt
View file

@ -839,7 +839,7 @@ Fields: ~
The view to use when the buffer is opened
for the first time in a session.
{eol_format} (string, default: '%l %c %r %d')
{eol_format} (string, default: '%c %r %d')
Format string for end-of-line virtual text.
Specifiers:
`%l` forge link label (`PendingForge`)
@ -1480,13 +1480,15 @@ Example: >
Fix login bug gh:user/repo#42 due:friday
<
On `:w`, the forge reference is stripped from the description, stored in the
task's `_extra._forge_ref` field, and rendered as right-aligned virtual text
alongside the due date and other metadata.
On `:w`, the forge reference stays in the description and is also stored in
the task's `_extra._forge_ref` field. The raw token is visually replaced
inline with a formatted label using overlay extmarks (same technique as
checkbox icons). Multiple forge references in one line are each overlaid
independently.
Only one forge reference per task. The `%l` specifier in `eol_format`
controls where the link label appears in the virtual text line. The default
`eol_format` is `'%l %c %r %d'` (link first).
The `%l` specifier in `eol_format` is still supported for users who prefer
the link label in EOL virtual text, but it is no longer in the default
format (`'%c %r %d'`).
Format string: ~
*pending-forge-format*
@ -1530,7 +1532,7 @@ Fields (per forge): ~
Falls back to CLI: `gh auth token` (GitHub), `glab auth
token` (GitLab). Codeberg uses token only.
{icon} (string) Nerd font icon used in virtual text.
{issue_format} (string) Format string for the EOL label.
{issue_format} (string) Format string for the inline overlay label.
{instances} (string[]) Additional hostnames for self-hosted instances
(e.g. `{ 'github.company.com' }`).