Skip to content

docs: fix typos in error messages, doc comments and examples - #66

Open
Avicennasis wants to merge 1 commit into
wefoxplatform:mainfrom
TypoScan3000:docs/fix-typos
Open

Avicennasis wants to merge 1 commit into
wefoxplatform:mainfrom
TypoScan3000:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fix typos and small grammar slips:

  • rustainers/src/runner/error.rs
    • UnsupportedVersion: expected to be ≥ that {minimal} → expected to be ≥ {minimal}
    • ComposeError: Fail run compose in … → Fail to run compose in … (matches the variant's doc comment, /// Fail to run compose)
  • rustainers/src/container/wait_condition.rs: healt check → health check (two doc comments)
  • componse-nginx → compose-nginx in the TemporaryDirectory doc example (src/compose/temp_dir.rs), the compose images module docs (src/compose/images/doc.md) and examples/compose_custom_images.rs
  • src/compose/images/doc.md: a temporary directory what will be removed → a temporary directory that will be removed

Two of these change the Display text of Error variants, and one changes the temporary-directory name prefix used by the compose_custom_images example. No tests or snapshots reference the changed strings. I left the existing Fail to … wording elsewhere as is, since it is used consistently across the crate.

No functional changes — comments, documentation and message strings only.

- runner/error.rs: "expected to be ≥ that {minimal}" -> "expected to be ≥ {minimal}"
- runner/error.rs: "Fail run compose" -> "Fail to run compose" (matches the variant's doc comment)
- container/wait_condition.rs: "healt check" -> "health check" (2x)
- compose/temp_dir.rs, compose/images/doc.md, examples/compose_custom_images.rs:
  "componse-nginx" -> "compose-nginx"
- compose/images/doc.md: "a temporary directory what will be removed" -> "that will be removed"

Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant