Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Avicennasis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rustainers/examples/compose_custom_images.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ struct ComposeNginx {
impl ComposeNginx {
async fn new() -> Self {
let temp_dir = TemporaryDirectory::with_files(
"componse-nginx",
"compose-nginx",
[TemporaryFile::builder()
.with_path("docker-compose.yaml")
.with_content(
Expand Down
4 changes: 2 additions & 2 deletions rustainers/src/compose/images/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ struct ComposeNginx {
impl ComposeNginx {

async fn new() -> Self {
// Create a temporary directory what will be removed when the containers stop
// Create a temporary directory that will be removed when the containers stop
let temp_dir = TemporaryDirectory::with_files(
"componse-nginx", // a name prefix
"compose-nginx", // a name prefix
[
// One docker-compose.yaml file
TemporaryFile::builder()
Expand Down
2 changes: 1 addition & 1 deletion rustainers/src/compose/temp_dir.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ pub struct TemporaryFile {
/// # use rustainers::compose::{TemporaryDirectory, TemporaryFile};
/// # async fn build() {
/// let temp_dir = TemporaryDirectory::with_files(
/// "componse-nginx",
/// "compose-nginx",
/// [TemporaryFile::builder()
/// .with_path("docker-compose.yaml")
/// .with_content(r#"..."#)
Expand Down
4 changes: 2 additions & 2 deletions rustainers/src/container/wait_condition.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ impl WaitStrategy {
Self::None
}

/// Wait with image healt check
/// Wait with image health check
#[must_use]
pub fn health_check() -> Self {
Self::HealthCheck
}

/// Wait with image healt check
/// Wait with image health check
#[must_use]
pub fn custom_health_check(health_check: HealthCheck) -> Self {
Self::CustomHealthCheck(health_check)
Expand Down
4 changes: 2 additions & 2 deletions rustainers/src/runner/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ pub enum RunnerError {
CommandNotAvailable(String),

/// Unsupported version
#[error("{command} version {current} expected to be ≥ that {minimal}")]
#[error("{command} version {current} expected to be ≥ {minimal}")]
UnsupportedVersion {
/// The command
command: String,
Expand Down Expand Up @@ -154,7 +154,7 @@ pub enum RunnerError {
},

/// Fail to run compose
#[error("Fail run compose in {path:?} because {source}\nrunner: {runner}")]
#[error("Fail to run compose in {path:?} because {source}\nrunner: {runner}")]
ComposeError {
/// The runner
runner: Runner,
Expand Down
Loading