Skip to content

Commit

Permalink
docs: fix some grammar errors in the doc of Operator
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveLauC committed Apr 30, 2023
1 parent a1270b0 commit 7703b44
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions core/src/types/operator/operator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ use crate::*;
///
/// We will usually do some general checks and data transformations in this layer,
/// like normalizing path from input, checking whether the path refers to one file or one directory, and so on.
/// Read [`concepts`][docs::concepts] for know more about [`Operator`].
/// Read [`concepts`][docs::concepts] for more about [`Operator`].
///
/// # Examples
///
Expand Down Expand Up @@ -164,7 +164,7 @@ impl Operator {
///
/// Use `stat` if you:
///
/// - Want detect the outside changes of path.
/// - Want to detect the outside changes of path.
/// - Don't want to read from cached metadata.
///
/// You may want to use `metadata` if you are working with entries
Expand Down Expand Up @@ -199,7 +199,7 @@ impl Operator {
///
/// Use `stat` if you:
///
/// - Want detect the outside changes of path.
/// - Want to detect the outside changes of path.
/// - Don't want to read from cached metadata.
///
/// You may want to use `metadata` if you are working with entries
Expand Down Expand Up @@ -247,7 +247,7 @@ impl Operator {
///
/// You may want to use `stat`, if you:
///
/// - Want detect the outside changes of path.
/// - Want to detect the outside changes of path.
/// - Don't want to read from cached metadata.
///
/// # Behavior
Expand All @@ -259,8 +259,8 @@ impl Operator {
///
/// ## Query already cached metadata
///
/// By query metadata with `None`, we can only query in-memory metadata
/// cache. In this way, we can make sure that no API call will send.
/// By querying metadata with `None`, we can only query in-memory metadata
/// cache. In this way, we can make sure that no API call will be sent.
///
/// ```
/// # use anyhow::Result;
Expand Down Expand Up @@ -300,7 +300,7 @@ impl Operator {
///
/// ## Query all metadata
///
/// By query metadata with `Complete`, we can make sure that we have fetched all metadata of this entry.
/// By querying metadata with `Complete`, we can make sure that we have fetched all metadata of this entry.
///
/// ```
/// # use anyhow::Result;
Expand Down Expand Up @@ -656,7 +656,7 @@ impl Operator {
///
/// - `from` and `to` must be a file.
/// - `to` will be overwritten if it exists.
/// - If `from` and `to` are the same, a `IsSameFile` error will occur.
/// - If `from` and `to` are the same, an `IsSameFile` error will occur.
/// - `copy` is idempotent. For same `from` and `to` input, the result will be the same.
///
/// # Examples
Expand Down Expand Up @@ -715,7 +715,7 @@ impl Operator {
///
/// - `from` and `to` must be a file.
/// - `to` will be overwritten if it exists.
/// - If `from` and `to` are the same, a `IsSameFile` error will occur.
/// - If `from` and `to` are the same, an `IsSameFile` error will occur.
///
/// # Examples
///
Expand Down Expand Up @@ -881,7 +881,7 @@ impl Operator {
///
/// # Notes
///
/// - Delete not existing error won't return errors.
/// - Deleting a file that does not exist won't return errors.
///
/// # Examples
///
Expand Down Expand Up @@ -927,9 +927,9 @@ impl Operator {
self.remove_via(stream::iter(paths)).await
}

/// remove will given paths.
/// remove will remove files via the given paths.
/// remove_via will remove files via given stream.
/// remove_via will remove files via the given stream.
///
/// We will delete by chunks with given batch limit on the stream.
///
Expand Down

0 comments on commit 7703b44

Please # to comment.