Skip to content

Fix typos and example reference in crate READMEs#9408

Merged
captainsafia merged 1 commit intowarpdotdev:masterfrom
anshul-garg27:fix/readme-typos-warpui-lsp
Apr 30, 2026
Merged

Fix typos and example reference in crate READMEs#9408
captainsafia merged 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

@captainsafia
Copy link
Copy Markdown
Contributor

@anshul-garg27 Thanks for these contributions! If you'd like to dive into some of the code, we've got a few bugs marked as ready-to-implement that you can take a look too.

@anshul-garg27
Copy link
Copy Markdown
Contributor Author

Thanks @captainsafia! Already on it — #9412 is a fix for the GitDiffStats flicker from #9228 (currently working through Oz's review feedback). Have a few more code-level fixes in flight that I'll be opening over the next day or two from the ready-to-implement queue.

@captainsafia captainsafia merged commit e05c5d2 into warpdotdev:master Apr 30, 2026
31 checks passed
@captainsafia captainsafia added the external-contributor Indicates that a PR has been opened by someone outside the Warp team. label Apr 30, 2026 — with Warp Dev Github Integration
zerx-lab pushed a commit to zerx-lab/warp that referenced this pull request May 3, 2026
### 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.

Co-authored-by: anshul-garg27 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed external-contributor Indicates that a PR has been opened by someone outside the Warp team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants