From ebac8c0c3588b23f4ca2d57003ad16f19509fdd1 Mon Sep 17 00:00:00 2001 From: Richard Schneeman Date: Wed, 2 Oct 2024 16:30:04 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Rune Soerensen --- libherokubuildpack/src/inventory.rs | 9 +++------ libherokubuildpack/src/inventory/artifact.rs | 2 +- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/libherokubuildpack/src/inventory.rs b/libherokubuildpack/src/inventory.rs index 19c4775a..5323bcab 100644 --- a/libherokubuildpack/src/inventory.rs +++ b/libherokubuildpack/src/inventory.rs @@ -1,11 +1,11 @@ //! # Inventory //! -//! Many buildpacks need to provided artifacts from different URLs. A helpful pattern +//! Many buildpacks need to provide artifacts from different URLs. A helpful pattern //! is to provide a list of artifacts in a TOML file, which can be parsed and used by //! the buildpack to download the correct artifact. For example, a Ruby buildpack -//! might need to download pre-compiled Ruby binary versions that are hosted on S3. +//! might need to download pre-compiled Ruby binaries hosted on S3. //! -//! This module contains code that can be used to produce and consume such an inventory file. +//! This module can be used to produce and consume such an inventory file. //! //! ## Features //! @@ -117,9 +117,6 @@ impl Inventory { } /// Add a new artifact to the in-memory inventory - /// - /// For removal, you can use the `Vec::retain` method on the artifacts attribute - /// to remove artifacts that match a given predicate. pub fn push(&mut self, artifact: Artifact) { self.artifacts.push(artifact); } diff --git a/libherokubuildpack/src/inventory/artifact.rs b/libherokubuildpack/src/inventory/artifact.rs index 5c9654d1..e13ae023 100644 --- a/libherokubuildpack/src/inventory/artifact.rs +++ b/libherokubuildpack/src/inventory/artifact.rs @@ -9,7 +9,7 @@ use std::str::FromStr; /// An inventory is made up of multiple artifacts that have a version that /// can be compared to each other and a URL where the artifact can be downloaded. /// -/// Some artifacts may be OS or architectures specific. The checksum value can +/// Artifacts are OS and architectures specific. The checksum value can /// be used to validate an artifact once it has been downloaded. /// /// Metadata can be used to store additional information about the artifact.