From a9eec5cbb55b4e7e736db2dbca9c55f5c0eaa7fc Mon Sep 17 00:00:00 2001 From: yegeunyang Date: Sun, 26 Jan 2025 12:41:03 -0600 Subject: [PATCH] Fix a typo and touch up documentation --- src/doc/man/cargo-metadata.md | 4 ++-- src/doc/man/generated_txt/cargo-metadata.txt | 8 ++++---- src/doc/src/commands/cargo-metadata.md | 4 ++-- src/etc/man/cargo-metadata.1 | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/doc/man/cargo-metadata.md b/src/doc/man/cargo-metadata.md index 431725c352e..5a878a74e87 100644 --- a/src/doc/man/cargo-metadata.md +++ b/src/doc/man/cargo-metadata.md @@ -13,9 +13,9 @@ cargo-metadata --- Machine-readable metadata about the current package Output JSON to stdout containing information about the workspace members and resolved dependencies of the current package. -The format of the output is subject to change in futures versions of Cargo. It +The output format is subject to change in future versions of Cargo. It is recommended to include the `--format-version` flag to future-proof your code -to ensure the output is in the format you are expecting. For more on the +and ensure the output is in the format you are expecting. For more on the expectations, see ["Compatibility"](#compatibility). See the [cargo_metadata crate](https://crates.io/crates/cargo_metadata) diff --git a/src/doc/man/generated_txt/cargo-metadata.txt b/src/doc/man/generated_txt/cargo-metadata.txt index 0fb8b8ad820..8c9a8dd2135 100644 --- a/src/doc/man/generated_txt/cargo-metadata.txt +++ b/src/doc/man/generated_txt/cargo-metadata.txt @@ -10,10 +10,10 @@ DESCRIPTION Output JSON to stdout containing information about the workspace members and resolved dependencies of the current package. - The format of the output is subject to change in futures versions of - Cargo. It is recommended to include the --format-version flag to - future-proof your code to ensure the output is in the format you are - expecting. For more on the expectations, see “Compatibility”. + The output format is subject to change in future versions of Cargo. It + is recommended to include the --format-version flag to future-proof your + code and ensure the output is in the format you are expecting. For more + on the expectations, see “Compatibility”. See the cargo_metadata crate for a Rust API for reading the metadata. diff --git a/src/doc/src/commands/cargo-metadata.md b/src/doc/src/commands/cargo-metadata.md index 52068e223c5..e742afdbc94 100644 --- a/src/doc/src/commands/cargo-metadata.md +++ b/src/doc/src/commands/cargo-metadata.md @@ -13,9 +13,9 @@ cargo-metadata --- Machine-readable metadata about the current package Output JSON to stdout containing information about the workspace members and resolved dependencies of the current package. -The format of the output is subject to change in futures versions of Cargo. It +The output format is subject to change in future versions of Cargo. It is recommended to include the `--format-version` flag to future-proof your code -to ensure the output is in the format you are expecting. For more on the +and ensure the output is in the format you are expecting. For more on the expectations, see ["Compatibility"](#compatibility). See the [cargo_metadata crate](https://crates.io/crates/cargo_metadata) diff --git a/src/etc/man/cargo-metadata.1 b/src/etc/man/cargo-metadata.1 index eb0e274d19e..7384ba7f3a2 100644 --- a/src/etc/man/cargo-metadata.1 +++ b/src/etc/man/cargo-metadata.1 @@ -11,9 +11,9 @@ cargo\-metadata \[em] Machine\-readable metadata about the current package Output JSON to stdout containing information about the workspace members and resolved dependencies of the current package. .sp -The format of the output is subject to change in futures versions of Cargo. It +The output format is subject to change in future versions of Cargo. It is recommended to include the \fB\-\-format\-version\fR flag to future\-proof your code -to ensure the output is in the format you are expecting. For more on the +and ensure the output is in the format you are expecting. For more on the expectations, see \[lq]Compatibility\[rq]\&. .sp See the \fIcargo_metadata crate\fR