Improve docs

This commit is contained in:
Andras Schmelczer 2025-07-12 11:21:57 +01:00
parent 7ee4fd8c72
commit ddd065dd3a
No known key found for this signature in database
GPG key ID: FC8F2C3D3D1A718C
2 changed files with 6 additions and 0 deletions

View file

@ -91,6 +91,10 @@ where
}
}
/// Merge two `EditedText` instances. The two instances must be derived
/// from the same original text. The operations are merged using the
/// principles of Operational Transformation. The cursors are updated
/// accordingly to reflect the changes made by the merged operations.
#[must_use]
#[allow(clippy::too_many_lines)]
pub fn merge(self, other: Self) -> Self {

View file

@ -1,5 +1,7 @@
/// Heuristically determine if the given data is a binary or a text file's
/// content.
///
/// Only text inputs can be reconciled using the crate's functions.
#[must_use]
pub fn is_binary(data: &[u8]) -> bool {
if data.contains(&0) {