Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gterzian committed Jul 17, 2023
1 parent 84189e2 commit a33aec8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/dochandle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ pub struct DocHandle {
/// or the last time it was access by any of the `with_doc` methods.
/// Putting it in a mutex to maintain an API
/// that doesn't require a mutabale reference to the handle.
/// Note: the mutex is not shared between clones of the same handle.
last_heads: Mutex<Vec<ChangeHash>>,
}

Expand Down
2 changes: 2 additions & 0 deletions src/repo.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ pub(crate) fn new_repo_future_with_resolver<F>() -> (RepoFuture<F>, RepoFutureRe

impl RepoHandle {
/// Stop the repo running in the background.
/// All documents will have been saved when this returns.
///
/// This call will block the current thread.
/// In an async context, use a variant of `spawn_blocking`.
///
Expand Down

0 comments on commit a33aec8

Please sign in to comment.