Update changelog and rustdocs for BuildpackReference changes
#677
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
edmorley
added
documentation
A few small tweaks: * `BuildpackReference` is only publicly exported at the root of the `libcnb-test` crate, so end users can't use it via the `build_config` module - so the `build_config::` references have been removed. * The new `BuildpackReference::WorkspaceBuildpack` variant supports only libcnb.rs and composite buildpacks, not eg bash buildpacks, so the "any buildpack" reference in the changelog has been clarified. Similarly, the rustdocs for `BuildpackReference` previously didn't mention composite buildpacks, only `libcnb.rs` buildpacks. * The "Rust workspace" references have been changed to "Cargo workspace" since it's Cargo not Rust that has the concept of a workspace: https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html * The rustdocs for `.buildpacks()` has been updated to include an example of using the new variant, and made to be consistent ordering wise with the example in the `libcnb-test` README. * The two changelog entries under "Added" have been consolidated, since they are covering the same newly added variant.
edmorley
force-pushed
the
edmorley/update-changelog-docs
branch
from
15957db to
d43dbf8
Compare
Malax
approved these changes
Sep 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A few small tweaks:
BuildpackReferenceis only publicly exported at the root of thelibcnb-testcrate, so end users can't use it via thebuild_configmodule - so thebuild_config::references have been removed.BuildpackReference::WorkspaceBuildpackvariant supports only libcnb.rs and composite buildpacks, not eg bash buildpacks, so the "any buildpack" reference in the changelog has been clarified to "any libcnb.rs or composite buildpack". Similarly, the rustdocs forBuildpackReferencehas been updated to mention composite buildpacks too, rather than onlylibcnb.rsbuildpacks..buildpacks()has been updated to include an example of using the new variant, and made to be consistent ordering wise with the example in thelibcnb-testREADME.GUS-W-14160805.