Repository navigation
docs(e2e): manual kitty verification procedure + demo inter-frame pause (K4) - #56
Merged
Merged
Conversation
…se (K4) - docs/manual-kitty-verification.md: step-by-step, by-eye verification of present()'s rendered output in a real kitty terminal, covering macOS and BSD (the platforms with no Xvfb equivalent), and cross-referencing tasks/plan.md T1/T4. - examples/src/bin/demo.rs: pause on a keypress between the two present() calls so a human can observe the first frame and the sprite's movement + background preservation separately, instead of only the final state.
Reviewer's GuideAdds a manual kitty-terminal verification guide and updates the demo to pause after its first frame, enabling visual confirmation of rendering, sprite movement, and background preservation alongside the automated E2E protocol check. Sequence diagram for the paused two-frame kitty demosequenceDiagram
participant User
participant Demo
participant KittyBackend
participant Terminal as KittyTerminal
User->>Demo: run demo
Demo->>KittyBackend: present(canvas)
KittyBackend->>Terminal: render first frame
Terminal-->>User: display full scene
Demo-->>User: eprintln First frame rendered
Demo->>User: read_line()
User-->>Demo: press Enter
Demo->>KittyBackend: present(canvas)
KittyBackend->>Terminal: render second frame
Terminal-->>User: display sprite at new position
User->>User: verify background has no trail
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 44 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 2 files
Reply with feedback, questions, or to request a fix.
View guided diff | Turn on auto-fix | Re-trigger cubic
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
The intro presented the automated Xvfb-backed E2E test as present, but it is added by a companion PR; reword to 'planned' so the manual doc does not claim an artifact that does not exist in this PR.
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
2 participants
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.
Summary by Sourcery
Improve Kitty rendering verification by documenting a manual real-terminal check and making the demo pause between frames.
Enhancements:
Documentation:
Chores:
Summary by cubic
Adds a manual, by-eye verification procedure for kitty rendering and pauses the demo between frames so a human can observe the first frame and the sprite's move separately.
The planned automated Linux-only E2E test (shipped via a companion PR) only proves kitty accepts the escape sequence; it cannot verify pixels render correctly, and macOS and BSD have no Xvfb equivalent.
Changes
docs/manual-kitty-verification.mdis a step-by-step procedure for real kitty-compatible terminals, including the expected output table and platform notes (BSD ships only thekittenCLI).examples/src/bin/demo.rsnow waits for Enter between the twopresent()calls so the first frame and the background restoration around the moved sprite are each observable — a singlepresent()after an in-memory move proves neither.Written for commit 5cf2900. Summary will update on new commits.