@@ -761,16 +761,17 @@ impl AsInner<fs_imp::DirEntry> for DirEntry {
761
761
/// # Platform behavior
762
762
///
763
763
/// This function currently corresponds to the `unlink` function on Unix
764
- /// and the `DeleteFile` function on Windows. Note that, this
765
- /// [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
764
+ /// and the `DeleteFile` function on Windows.
765
+ /// Note that, this [may change in the future][changes].
766
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
766
767
///
767
768
/// # Errors
768
769
///
769
770
/// This function will return an error in the following situations, but is not
770
771
/// limited to just these cases:
771
772
///
772
- /// * `path` points to a directory
773
- /// * The user lacks permissions to remove the file
773
+ /// * `path` points to a directory.
774
+ /// * The user lacks permissions to remove the file.
774
775
///
775
776
/// # Examples
776
777
///
@@ -796,16 +797,17 @@ pub fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> {
796
797
/// # Platform behavior
797
798
///
798
799
/// This function currently corresponds to the `stat` function on Unix
799
- /// and the `GetFileAttributesEx` function on Windows. Note that, this
800
- /// [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
800
+ /// and the `GetFileAttributesEx` function on Windows.
801
+ /// Note that, this [may change in the future][changes].
802
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
801
803
///
802
804
/// # Errors
803
805
///
804
806
/// This function will return an error in the following situations, but is not
805
807
/// limited to just these cases:
806
808
///
807
- /// * The user lacks permissions to perform `metadata` call on `path`
808
- /// * `path` does not exist
809
+ /// * The user lacks permissions to perform `metadata` call on `path`.
810
+ /// * `path` does not exist.
809
811
///
810
812
/// # Examples
811
813
///
@@ -828,16 +830,17 @@ pub fn metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
828
830
/// # Platform behavior
829
831
///
830
832
/// This function currently corresponds to the `lstat` function on Unix
831
- /// and the `GetFileAttributesEx` function on Windows. Note that, this
832
- /// [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
833
+ /// and the `GetFileAttributesEx` function on Windows.
834
+ /// Note that, this [may change in the future][changes].
835
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
833
836
///
834
837
/// # Errors
835
838
///
836
839
/// This function will return an error in the following situations, but is not
837
840
/// limited to just these cases:
838
841
///
839
- /// * The user lacks permissions to perform `metadata` call on `path`
840
- /// * `path` does not exist
842
+ /// * The user lacks permissions to perform `metadata` call on `path`.
843
+ /// * `path` does not exist.
841
844
///
842
845
/// # Examples
843
846
///
@@ -863,16 +866,17 @@ pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
863
866
///
864
867
/// This function currently corresponds to the `rename` function on Unix
865
868
/// and the `MoveFileEx` function with the `MOVEFILE_REPLACE_EXISTING` flag on Windows.
866
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
869
+ /// Note that, this [may change in the future][changes].
870
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
867
871
///
868
872
/// # Errors
869
873
///
870
874
/// This function will return an error in the following situations, but is not
871
875
/// limited to just these cases:
872
876
///
873
- /// * `from` does not exist
874
- /// * The user lacks permissions to view contents
875
- /// * `from` and `to` are on separate filesystems
877
+ /// * `from` does not exist.
878
+ /// * The user lacks permissions to view contents.
879
+ /// * `from` and `to` are on separate filesystems.
876
880
///
877
881
/// # Examples
878
882
///
@@ -905,17 +909,18 @@ pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()>
905
909
/// with `O_RDONLY` for `from` and `O_WRONLY`, `O_CREAT`, and `O_TRUNC` for `to`.
906
910
/// `O_CLOEXEC` is set for returned file descriptors.
907
911
/// On Windows, this function currently corresponds to `CopyFileEx`.
908
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
912
+ /// Note that, this [may change in the future][changes].
913
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
909
914
///
910
915
/// # Errors
911
916
///
912
917
/// This function will return an error in the following situations, but is not
913
918
/// limited to just these cases:
914
919
///
915
- /// * The `from` path is not a file
916
- /// * The `from` file does not exist
920
+ /// * The `from` path is not a file.
921
+ /// * The `from` file does not exist.
917
922
/// * The current process does not have the permission rights to access
918
- /// `from` or write `to`
923
+ /// `from` or write `to`.
919
924
///
920
925
/// # Examples
921
926
///
@@ -940,14 +945,15 @@ pub fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<u64> {
940
945
///
941
946
/// This function currently corresponds to the `link` function on Unix
942
947
/// and the `CreateHardLink` function on Windows.
943
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
948
+ /// Note that, this [may change in the future][changes].
949
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
944
950
///
945
951
/// # Errors
946
952
///
947
953
/// This function will return an error in the following situations, but is not
948
954
/// limited to just these cases:
949
955
///
950
- /// * The `src` path is not a file or doesn't exist
956
+ /// * The `src` path is not a file or doesn't exist.
951
957
///
952
958
/// # Examples
953
959
///
@@ -997,15 +1003,16 @@ pub fn soft_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<(
997
1003
/// This function currently corresponds to the `readlink` function on Unix
998
1004
/// and the `CreateFile` function with `FILE_FLAG_OPEN_REPARSE_POINT` and
999
1005
/// `FILE_FLAG_BACKUP_SEMANTICS` flags on Windows.
1000
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
1006
+ /// Note that, this [may change in the future][changes].
1007
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
1001
1008
///
1002
1009
/// # Errors
1003
1010
///
1004
1011
/// This function will return an error in the following situations, but is not
1005
1012
/// limited to just these cases:
1006
1013
///
1007
- /// * `path` is not a symbolic link
1008
- /// * `path` does not exist
1014
+ /// * `path` is not a symbolic link.
1015
+ /// * `path` does not exist.
1009
1016
///
1010
1017
/// # Examples
1011
1018
///
@@ -1029,15 +1036,16 @@ pub fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
1029
1036
///
1030
1037
/// This function currently corresponds to the `realpath` function on Unix
1031
1038
/// and the `CreateFile` and `GetFinalPathNameByHandle` functions on Windows.
1032
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
1039
+ /// Note that, this [may change in the future][changes].
1040
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
1033
1041
///
1034
1042
/// # Errors
1035
1043
///
1036
1044
/// This function will return an error in the following situations, but is not
1037
1045
/// limited to just these cases:
1038
1046
///
1039
- /// * `path` does not exist
1040
- /// * A component in path is not a directory
1047
+ /// * `path` does not exist.
1048
+ /// * A component in path is not a directory.
1041
1049
///
1042
1050
/// # Examples
1043
1051
///
@@ -1060,15 +1068,16 @@ pub fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
1060
1068
///
1061
1069
/// This function currently corresponds to the `mkdir` function on Unix
1062
1070
/// and the `CreateDirectory` function on Windows.
1063
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
1071
+ /// Note that, this [may change in the future][changes].
1072
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
1064
1073
///
1065
1074
/// # Errors
1066
1075
///
1067
1076
/// This function will return an error in the following situations, but is not
1068
1077
/// limited to just these cases:
1069
1078
///
1070
- /// * User lacks permissions to create directory at `path`
1071
- /// * `path` already exists
1079
+ /// * User lacks permissions to create directory at `path`.
1080
+ /// * `path` already exists.
1072
1081
///
1073
1082
/// # Examples
1074
1083
///
@@ -1092,7 +1101,8 @@ pub fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1092
1101
///
1093
1102
/// This function currently corresponds to the `mkdir` function on Unix
1094
1103
/// and the `CreateDirectory` function on Windows.
1095
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
1104
+ /// Note that, this [may change in the future][changes].
1105
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
1096
1106
///
1097
1107
/// # Errors
1098
1108
///
@@ -1125,15 +1135,16 @@ pub fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
1125
1135
///
1126
1136
/// This function currently corresponds to the `rmdir` function on Unix
1127
1137
/// and the `RemoveDirectory` function on Windows.
1128
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
1138
+ /// Note that, this [may change in the future][changes].
1139
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
1129
1140
///
1130
1141
/// # Errors
1131
1142
///
1132
1143
/// This function will return an error in the following situations, but is not
1133
1144
/// limited to just these cases:
1134
1145
///
1135
- /// * The user lacks permissions to remove the directory at the provided `path`
1136
- /// * The directory isn't empty
1146
+ /// * The user lacks permissions to remove the directory at the provided `path`.
1147
+ /// * The directory isn't empty.
1137
1148
///
1138
1149
/// # Examples
1139
1150
///
@@ -1161,7 +1172,8 @@ pub fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
1161
1172
/// This function currently corresponds to `opendir`, `lstat`, `rm` and `rmdir` functions on Unix
1162
1173
/// and the `FindFirstFile`, `GetFileAttributesEx`, `DeleteFile`, and `RemoveDirectory` functions
1163
1174
/// on Windows.
1164
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
1175
+ /// Note that, this [may change in the future][changes].
1176
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
1165
1177
///
1166
1178
/// # Errors
1167
1179
///
@@ -1204,16 +1216,17 @@ fn _remove_dir_all(path: &Path) -> io::Result<()> {
1204
1216
///
1205
1217
/// This function currently corresponds to the `opendir` function on Unix
1206
1218
/// and the `FindFirstFile` function on Windows.
1207
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
1219
+ /// Note that, this [may change in the future][changes].
1220
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
1208
1221
///
1209
1222
/// # Errors
1210
1223
///
1211
1224
/// This function will return an error in the following situations, but is not
1212
1225
/// limited to just these cases:
1213
1226
///
1214
- /// * The provided `path` doesn't exist
1215
- /// * The process lacks permissions to view the contents
1216
- /// * The `path` points at a non-directory file
1227
+ /// * The provided `path` doesn't exist.
1228
+ /// * The process lacks permissions to view the contents.
1229
+ /// * The `path` points at a non-directory file.
1217
1230
///
1218
1231
/// # Examples
1219
1232
///
@@ -1306,15 +1319,16 @@ impl Iterator for WalkDir {
1306
1319
///
1307
1320
/// This function currently corresponds to the `chmod` function on Unix
1308
1321
/// and the `SetFileAttributes` function on Windows.
1309
- /// Note that, this [may change in the future.][https://github.com/rust-lang/rust/pull/28613]
1322
+ /// Note that, this [may change in the future][changes].
1323
+ /// [changes]: https://github.com/rust-lang/rust/pull/28613
1310
1324
///
1311
1325
/// # Errors
1312
1326
///
1313
1327
/// This function will return an error in the following situations, but is not
1314
1328
/// limited to just these cases:
1315
1329
///
1316
- /// * `path` does not exist
1317
- /// * The user lacks the permission to change attributes of the file
1330
+ /// * `path` does not exist.
1331
+ /// * The user lacks the permission to change attributes of the file.
1318
1332
///
1319
1333
/// # Examples
1320
1334
///
0 commit comments