barrettruth/ci.nvim
Watch
1
0
Fork
You've already forked ci.nvim
 0
Code Issues Pull requests Releases Packages Activity Actions

docs: stop claiming there is no polling #38

Merged
barrettruth merged 1 commit from docs/say-that-it-polls into main 2026-07-28 06:17:56 +00:00
Conversation 0 Commits 1 Files changed 1 +5 -3
barrettruth commented 2026-07-28 06:16:12 +00:00
Owner
Copy link

Checklist

  • I have read CONTRIBUTING.md.
  • No AI was used to generate, edit, or review any part of this contribution.

Problem

The help contradicted itself:

doc/ci.txt:79    There is no polling. Press `:e` or `R` to refresh…
doc/ci.txt:171   …refreshed on the same ten-second poll as a list…

Line 79 was written when there was no polling and was never revisited when #34
added it.

Solution

A buffer with anything still running reloads itself every ten seconds and
stops once the checks settle, or once no window is showing it. `:e` and `R`
refresh on demand; either way the cursor and scroll position are kept.

The stopping conditions are worth stating, since "it polls" on its own reads
like something that runs forever.

## Checklist - [x] I have read [CONTRIBUTING.md](https://forge.barrettruth.com/barrettruth/ci.nvim/src/branch/main/CONTRIBUTING.md). - [ ] No AI was used to generate, edit, or review any part of this contribution. ## Problem The help contradicted itself: ``` doc/ci.txt:79 There is no polling. Press `:e` or `R` to refresh… doc/ci.txt:171 …refreshed on the same ten-second poll as a list… ``` Line 79 was written when there was no polling and was never revisited when #34 added it. ## Solution ``` A buffer with anything still running reloads itself every ten seconds and stops once the checks settle, or once no window is showing it. `:e` and `R` refresh on demand; either way the cursor and scroll position are kept. ``` The stopping conditions are worth stating, since "it polls" on its own reads like something that runs forever.
docs: stop claiming there is no polling
All checks were successful
quality / Format (pull_request) Successful in 5s
Details
quality / Lint (pull_request) Successful in 7s
Details
quality / Test (pull_request) Successful in 7s
Details
f730bcb29e
 
Problem: The buffers section still said there is no polling, which stopped
being true when lists began reloading themselves, and the limitations section
a hundred lines below already described the ten-second poll.

Solution: Say what it does, and when it stops.
barrettruth deleted branch docs/say-that-it-polls 2026-07-28 06:17:56 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
barrettruth/ci.nvim!38
No description provided.