docs(gpui): point the crate readme at moon packages - #79
Merged
Merged
Conversation
The moon-gpui readme told applications to depend on crates.io packages gpui and gpui_platform at version "*". Both packages set publish = false and are named moon-gpui and moon-gpui-platform. The Application doc comment named App::run, which is not a method. Getting-started snippets now match the root readme's git dependencies. Application::run is the method that starts the app.
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.
What & why
crates/moon-gpui/README.mdstill told applications to add crates.io packagesgpuiandgpui_platformatversion = "*". Those names are not the packages in this repository.moon-gpuiandmoon-gpui-platformboth setpublish = false; the Rust crate name ofmoon-gpuiisgpui, and applications depend on the git repository the way the root README already shows. The same staleversion = "*"form was repeated in the macOS and Linux feature snippets.The
Applicationdoc comment said to start the app withApp::run.Apphas norunmethod.Application::runis the method that takes the launch callback.The feature prose (Metal,
font-kitfalling back toNoopTextSystem, Wayland/X11 pulling in the renderer, Windows DirectWrite withfont-kitunused) was left as written. It still matches the platform crates.How to verify
Compared the new dependency lines with
crates/moon-gpui/Cargo.toml,crates/moon-gpui-platform/Cargo.toml,gpui_platform::application, and the root README "Use From Cargo" section. ConfirmedApplication::runincrates/moon-gpui/src/app.rsand thatApp::runis not defined. A separate read of the diff against those sources found no mismatch.cargo fmt --all -- --checkis clean.This change touches a doc comment in a
.rsfile, so MoonUI Guardrails is in scope as well asalena-review.