Skip to content

Commit

Permalink
Clarify get_bytes documentation as debug builds use absolute paths
Browse files Browse the repository at this point in the history
See also issue #10 for discussion.
  • Loading branch information
evolutics committed May 4, 2024
1 parent 60fa39a commit 5e04e87
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@ asset type is generated without further configuration. See
panics if there is any error such as if the file does not exist. This helps
with faster development, as it avoids rebuilding if asset file contents are
changed only (note that you still need to rebuild if assets are added,
renamed, or removed).
renamed, or removed). The asset file is located based on its absolute path in
the build environment, likely rendering the binary unfit for distribution.

In release builds, it returns the file contents included at compile time,
using
Expand Down
3 changes: 2 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,8 @@
//! panics if there is any error such as if the file does not exist. This helps
//! with faster development, as it avoids rebuilding if asset file contents are
//! changed only (note that you still need to rebuild if assets are added,
//! renamed, or removed).
//! renamed, or removed). The asset file is located based on its absolute path in
//! the build environment, likely rendering the binary unfit for distribution.
//!
//! In release builds, it returns the file contents included at compile time,
//! using
Expand Down

0 comments on commit 5e04e87

Please sign in to comment.