Repository navigation
docs: document the split-window fan-out workaround for show() - #53
Merged
Merged
Conversation
PR #51 (issue #10, multi-location placement fan-out) added the underlying primitive but never updated README/doc/blit.txt, despite docs/review-checklist.md's Tests & Docs category requiring vimdoc and README updates for user-facing behavior. Document the one concrete, user-actionable consequence: calling show() again with the same path reuses the already-transmitted image data and is the way to place the same image into a second window after :split/:vsplit today, since show() still binds one handle to one window and doesn't auto-detect splits.
![amazon-q-developer[bot]](https://avatars.githubusercontent.com/in/1220912?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation-only changes that accurately document the split-window limitation and workaround for show(). The content is technically correct, well-written, and consistent across both README.md and doc/blit.txt. No blocking issues identified.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
2 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📦 Pull Request
Description
PR #51 (issue #10, multi-location placement fan-out) added the underlying primitive — a distinct
p=per placement, so the same transmitted image id can carry a second, independent placement without re-transmitting — but never updatedREADME.md/doc/blit.txt, even thoughdocs/spec/renderer-placement.md's own "Reserving space: virt_lines" section already documents a concrete, user-actionable consequence: callingshow()again with the samepath(and a differentwin) is the way to display the same image in a second window after:split/:vsplittoday, sinceshow()still binds one handle to one window and doesn't auto-detect splits.This adds that same workaround to:
README.md's "Known Issues" section (new bullet, split-window limitation + workaround)doc/blit.txt'sshow()API docs (new paragraph, same content in vimdoc style)No code changes.
Related Issue
Related to #10 (the underlying primitive this workaround relies on).
Type of Change
Checklist
makelocally (stylua --check,selene, tests) and it passes.docs/spec/memo if protocol or terminal-detection behavior changed.doc/blit.txtand/or README if this changes the public API.feat:,fix:, etc.).