Skip to content

Commit e8be334

Browse files
authored
Fix documentation issues for src/lib.rs (#52)
Signed-off-by: wyrapeseed <[email protected]>
1 parent 39c8d7d commit e8be334

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,11 @@ pub async fn copy<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<
120120
///
121121
/// This function currently corresponds to the `mkdir` function on Unix
122122
/// and the `CreateDirectory` function on Windows.
123-
/// Note that, this [may change in the future][changes].
123+
/// Note that this [may change in the future][changes].
124124
///
125125
/// [changes]: io#platform-specific-behavior
126126
///
127-
/// **NOTE**: If a parent of the given path doesn't exist, this function will
127+
/// Note that if a parent of the given path doesn't exist, this function will
128128
/// return an error. To create a directory and all its missing parents at the
129129
/// same time, use the [`create_dir_all`] function.
130130
///
@@ -161,7 +161,7 @@ pub async fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
161161
///
162162
/// This function currently corresponds to the `mkdir` function on Unix
163163
/// and the `CreateDirectory` function on Windows.
164-
/// Note that, this [may change in the future][changes].
164+
/// Note that this [may change in the future][changes].
165165
///
166166
/// [changes]: io#platform-specific-behavior
167167
///
@@ -980,14 +980,14 @@ impl File {
980980

981981
/// Synchronizes OS-internal buffered contents to disk.
982982
///
983-
/// This is similar to [`sync_all()`][`File::sync_data()`], except that file metadata may not
983+
/// This is similar to [`sync_all()`][`File::sync_all()`], except that file metadata may not
984984
/// be synchronized.
985985
///
986986
/// This is intended for use cases that must synchronize the contents of the file, but don't
987987
/// need the file metadata synchronized to disk.
988988
///
989989
/// Note that some platforms may simply implement this in terms of
990-
/// [`sync_all()`][`File::sync_data()`].
990+
/// [`sync_all()`][`File::sync_all()`].
991991
///
992992
/// # Examples
993993
///

0 commit comments

Comments
 (0)