docs(gpui): point examples at the moon-gpui package - #86
Merged
Merged
Conversation
The examples index still said to run them from a Zed checkout with `cargo run -p gpui`. That package is not in this workspace, so the command fails. The index also omitted a11y and gpu_canvas, which cargo lists as examples. The same wrong package name was in three example module comments.
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
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.
What & why
crates/moon-gpui/examples/README.mdstill said to run examples from a Zed checkout withcargo run -p gpui --example hello_world. The package in this workspace ismoon-gpui.cargo run -p gpui --examplefails withpackage(s) gpui not found.cargo run -p moon-gpui --examplelists the examples, includinga11yandgpu_canvas, which the index never mentioned.a11ysets AccessKit roles on a heading, a spin button, a switch, and a list, and exposes increment, decrement, and toggle actions.gpu_canvasdrives agpu_canvaselement that returnsGpuFrameDecision::RequestPresenton a 500 ms interval and does not dirty the view.The same
-p gpuicommand was in the module comments ofa11y.rs,testing.rs, andmove_entity_between_windows.rs. Those comments now namemoon-gpui. The Linux feature flagsgpui_platform/waylandandgpui_platform/x11, andtest-support, are unchanged and still exist on the dev-dependency.A clean-context review compared the new sentences with
Cargo.toml,a11y.rs, andgpu_canvas.rsand found each claim true. Nothing was dropped.How to verify
Markdown and
//!comments only. No logic, signatures, or tests changed.The first command fails because no package is named
gpui. The second listshello_world,a11y, andgpu_canvas.