Skip to content

Bring projects, wikis, and teams together with AI. AppFlowy is the AI collaborative workspace where you achieve more without losing control of your data. The leading open source Notion alternative.

docs: made minor changes to grammar

MikeWallaceDev7436f7de3ea7
diff --git a/shared-lib/lib-ot/src/core/delta/builder.rs b/shared-lib/lib-ot/src/core/delta/builder.rs
index 9e67495da0..44e4d4dbac 100644
--- a/shared-lib/lib-ot/src/core/delta/builder.rs
+++ b/shared-lib/lib-ot/src/core/delta/builder.rs
@@ -46,7 +46,7 @@ where
self
}
- /// Insert the string with attributes. Use 'insert' instead if you don't
+ /// Inserts the string with attributes. Use 'insert' instead if you don't
/// need any attributes.
pub fn insert_with_attributes(mut self, s: &str, attrs: T) -> Self {
self.delta.insert(s, attrs);
diff --git a/shared-lib/lib-ot/src/core/delta/cursor.rs b/shared-lib/lib-ot/src/core/delta/cursor.rs
index a465d62dea..2243adb7b3 100644
--- a/shared-lib/lib-ot/src/core/delta/cursor.rs
+++ b/shared-lib/lib-ot/src/core/delta/cursor.rs
@@ -53,17 +53,17 @@ where
cursor
}
- /// Return the next operation interval
+ /// Returns the next operation interval
pub fn next_iv(&self) -> Interval {
self.next_iv_with_len(None).unwrap_or_else(|| Interval::new(0, 0))
}
- /// Return the next operation
+ /// Returns the next operation
pub fn get_next_op(&mut self) -> Option<Operation<T>> {
self.next_with_len(None)
}
- /// Return the reference of the next operation
+ /// Returns the reference of the next operation
pub fn next_op(&self) -> Option<&Operation<T>> {
let mut next_op = self.next_op.as_ref();
if next_op.is_none() {
@@ -138,8 +138,8 @@ where
self.next_op().is_some()
}
- /// Find the op within the current offset.
- /// This function sets the start of the consume_iv to the offset, update the consume_count
+ /// Finds the op within the current offset.
+ /// This function sets the start of the consume_iv to the offset, updates the consume_count
/// and the next_op reference.
///
/// # Arguments
diff --git a/shared-lib/lib-ot/src/core/operation/operation.rs b/shared-lib/lib-ot/src/core/operation/operation.rs
index ac56025621..26ac7650ec 100644
--- a/shared-lib/lib-ot/src/core/operation/operation.rs
+++ b/shared-lib/lib-ot/src/core/operation/operation.rs
@@ -41,7 +41,7 @@ pub trait OperationTransformable {
where
Self: Sized;
- /// Return the invert delta from the other. It can be used to do the undo operation.
+ /// Returns the invert delta from the other. It can be used to do the undo operation.
///
/// # Arguments
///