@@ -1070,8 +1070,10 @@ pub(crate) mod builtin {
1070
1070
1071
1071
/// Includes a utf8-encoded file as a string.
1072
1072
///
1073
- /// The file is located relative to the current file. (similarly to how
1074
- /// modules are found)
1073
+ /// The file is located relative to the current file (similarly to how
1074
+ /// modules are found). The provided path is interpreted in a platform-specific
1075
+ /// way at compile time. So, for instance, an invocation with a Windows path
1076
+ /// containing backslashes `\` would not compile correctly on Unix.
1075
1077
///
1076
1078
/// This macro will yield an expression of type `&'static str` which is the
1077
1079
/// contents of the file.
@@ -1108,8 +1110,10 @@ pub(crate) mod builtin {
1108
1110
1109
1111
/// Includes a file as a reference to a byte array.
1110
1112
///
1111
- /// The file is located relative to the current file. (similarly to how
1112
- /// modules are found)
1113
+ /// The file is located relative to the current file (similarly to how
1114
+ /// modules are found). The provided path is interpreted in a platform-specific
1115
+ /// way at compile time. So, for instance, an invocation with a Windows path
1116
+ /// containing backslashes `\` would not compile correctly on Unix.
1113
1117
///
1114
1118
/// This macro will yield an expression of type `&'static [u8; N]` which is
1115
1119
/// the contents of the file.
@@ -1202,7 +1206,9 @@ pub(crate) mod builtin {
1202
1206
/// Parses a file as an expression or an item according to the context.
1203
1207
///
1204
1208
/// The file is located relative to the current file (similarly to how
1205
- /// modules are found).
1209
+ /// modules are found). The provided path is interpreted in a platform-specific
1210
+ /// way at compile time. So, for instance, an invocation with a Windows path
1211
+ /// containing backslashes `\` would not compile correctly on Unix.
1206
1212
///
1207
1213
/// Using this macro is often a bad idea, because if the file is
1208
1214
/// parsed as an expression, it is going to be placed in the
0 commit comments