Skip to content

Fix typos and example reference in crate READMEs#9408

Open
anshul-garg27 wants to merge 1 commit intowarpdotdev:masterfrom
anshul-garg27:fix/readme-typos-warpui-lsp
Open

Fix typos and example reference in crate READMEs#9408
anshul-garg27 wants to merge 1 commit intowarpdotdev:masterfrom
anshul-garg27:fix/readme-typos-warpui-lsp

Conversation

@anshul-garg27
Copy link
Copy Markdown
Contributor

Description

Two README files in `crates/` had typos and one had an ambiguous file reference:

`crates/warpui_core/README.md`

  • "to do describe" → "To describe"
  • "appearence" → "appearance"
  • "precicely" → "precisely"
  • "handlign" → "handling"

`crates/lsp/README.md`

  • "implmentation" → "implementation"
  • The README said "See main.rs for an example implementation" but there is no `main.rs` in `crates/lsp/src/`. The example actually lives at `crates/lsp/examples/rust-lsp/main.rs`, so I made the path explicit.

Doc-only changes.

Testing

Markdown only.

Server API

No server changes.

Agent Mode

Not applicable.

Changelog Entries

None.

- crates/warpui_core/README.md
  - "to do describe" -> "To describe"
  - "appearence" -> "appearance"
  - "precicely" -> "precisely"
  - "handlign" -> "handling"

- crates/lsp/README.md
  - "implmentation" -> "implementation"
  - "See main.rs" was ambiguous (no main.rs in src/); point at the
    actual example file at examples/rust-lsp/main.rs.

Doc-only.
@cla-bot cla-bot Bot added the cla-signed label Apr 29, 2026
@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented Apr 29, 2026

@anshul-garg27

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I approved this pull request. No matching stakeholder was found for the changed files, so no human reviewers were requested.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR fixes typos in crate README documentation and clarifies the LSP example reference to the existing examples/rust-lsp/main.rs file.

Concerns

  • No correctness, security, or documentation concerns found in the changed lines.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant