Skip to content

Commit 5616fe8

Browse files
committed
Add warning that matching behavior may change at any time
1 parent 31009e7 commit 5616fe8

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,9 @@ better behavior.
147147

148148
## How `ubi` Finds the Right Release Artifact
149149

150+
> [!WARNING] Note that the exact set of steps that `ubi` follows to find a release artifacts is not
151+
> considered part of the API, and may change in any future release.
152+
150153
When `ubi` looks at the release assets (downloadable files) for a project, it tries to find the
151154
"right" asset for the platform it's running on. The matching logic currently works like this:
152155

ubi/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@
4444
//!
4545
//! ## How `ubi` Finds the Right Release Artifact
4646
//!
47+
//! <div class="warning">Note that the exact set of steps that are followed to find a release
48+
//! artifacts is not considered part of the API, and may change in any future release.</div>
49+
//!
4750
//! When you call [`Ubi::install_binary`], it looks at the release assets (downloadable files) for a
4851
//! project and tries to find the "right" asset for the platform it's running on. The matching logic
4952
//! currently works like this:

0 commit comments

Comments
 (0)