diff options
author | Oleg Nosov <olegnosov1@gmail.com> | 2020-01-24 20:31:13 +0300 |
---|---|---|
committer | Carl Lerche <me@carllerche.com> | 2020-01-24 09:31:13 -0800 |
commit | f9ddb93604a830d106475bd4c4cae436fafcc0da (patch) | |
tree | 6f200680e68b290794ef0512dcb031ef6d81c5ea /tokio/src/fs | |
parent | a70f7203a46d471345128832987017612d8e4585 (diff) |
docs: use third form in API docs (#2027)
Diffstat (limited to 'tokio/src/fs')
-rw-r--r-- | tokio/src/fs/create_dir_all.rs | 2 | ||||
-rw-r--r-- | tokio/src/fs/file.rs | 4 | ||||
-rw-r--r-- | tokio/src/fs/metadata.rs | 2 | ||||
-rw-r--r-- | tokio/src/fs/read.rs | 2 | ||||
-rw-r--r-- | tokio/src/fs/read_dir.rs | 4 | ||||
-rw-r--r-- | tokio/src/fs/rename.rs | 2 |
6 files changed, 8 insertions, 8 deletions
diff --git a/tokio/src/fs/create_dir_all.rs b/tokio/src/fs/create_dir_all.rs index 7d89280d..21f0c82d 100644 --- a/tokio/src/fs/create_dir_all.rs +++ b/tokio/src/fs/create_dir_all.rs @@ -3,7 +3,7 @@ use crate::fs::asyncify; use std::io; use std::path::Path; -/// Recursively create a directory and all of its parent components if they +/// Recursively creates a directory and all of its parent components if they /// are missing. /// /// This is an async version of [`std::fs::create_dir_all`][std] diff --git a/tokio/src/fs/file.rs b/tokio/src/fs/file.rs index 9110831a..a1f22fc9 100644 --- a/tokio/src/fs/file.rs +++ b/tokio/src/fs/file.rs @@ -155,7 +155,7 @@ impl File { Ok(File::from_std(std_file)) } - /// Convert a [`std::fs::File`][std] to a [`tokio::fs::File`][file]. + /// Converts a [`std::fs::File`][std] to a [`tokio::fs::File`][file]. /// /// [std]: std::fs::File /// [file]: File @@ -176,7 +176,7 @@ impl File { } } - /// Seek to an offset, in bytes, in a stream. + /// Seeks to an offset, in bytes, in a stream. /// /// # Examples /// diff --git a/tokio/src/fs/metadata.rs b/tokio/src/fs/metadata.rs index 6bbb44ad..ff9cded7 100644 --- a/tokio/src/fs/metadata.rs +++ b/tokio/src/fs/metadata.rs @@ -4,7 +4,7 @@ use std::fs::Metadata; use std::io; use std::path::Path; -/// Given a path, query the file system to get information about a file, +/// Given a path, queries the file system to get information about a file, /// directory, etc. /// /// This is an async version of [`std::fs::metadata`][std] diff --git a/tokio/src/fs/read.rs b/tokio/src/fs/read.rs index f61275d0..2d80eb5b 100644 --- a/tokio/src/fs/read.rs +++ b/tokio/src/fs/read.rs @@ -2,7 +2,7 @@ use crate::fs::asyncify; use std::{io, path::Path}; -/// Read the entire contents of a file into a bytes vector. +/// Reads the entire contents of a file into a bytes vector. /// /// This is an async version of [`std::fs::read`][std] /// diff --git a/tokio/src/fs/read_dir.rs b/tokio/src/fs/read_dir.rs index 06eed384..fbc006df 100644 --- a/tokio/src/fs/read_dir.rs +++ b/tokio/src/fs/read_dir.rs @@ -165,7 +165,7 @@ impl DirEntry { self.0.file_name() } - /// Return the metadata for the file that this entry points at. + /// Returns the metadata for the file that this entry points at. /// /// This function will not traverse symlinks if this entry points at a /// symlink. @@ -200,7 +200,7 @@ impl DirEntry { asyncify(move || std.metadata()).await } - /// Return the file type for the file that this entry points at. + /// Returns the file type for the file that this entry points at. /// /// This function will not traverse symlinks if this entry points at a /// symlink. diff --git a/tokio/src/fs/rename.rs b/tokio/src/fs/rename.rs index de647da9..4f980821 100644 --- a/tokio/src/fs/rename.rs +++ b/tokio/src/fs/rename.rs @@ -3,7 +3,7 @@ use crate::fs::asyncify; use std::io; use std::path::Path; -/// Rename a file or directory to a new name, replacing the original file if +/// Renames a file or directory to a new name, replacing the original file if /// `to` already exists. /// /// This will not work if the new name is on a different mount point. |