Radish alpha
r
rad:z2UcCU1LgMshWvXj6hXSDDrwB8q8M
Radicle Job Collaborative Object
Radicle
Git
docs: document `Jobs::get` and `Jobs::get_mut`
Lars Wirzenius committed 10 months ago
commit 524dfdb12a3c88cee5919aefd3456d55f8258f97
parent 1ce1229
1 file changed +2 -2
modified src/lib.rs
@@ -598,7 +598,7 @@ where
        Ok(self.all()?.count())
    }

-
    /// Get a [`Job`].
+
    /// Get a [`Job`], given its [`JobId`] identifier.
    pub fn get(&self, id: &JobId) -> Result<Option<Job>, store::Error> {
        self.raw.get(id.as_object_id())
    }
@@ -608,7 +608,7 @@ impl<'a, R> Jobs<'a, R>
where
    R: ReadRepository + SignRepository + cob::Store<Namespace = NodeId>,
{
-
    /// Get a [`JobMut`].
+
    /// Get a [`JobMut`], given its [`JobId`] identifier.
    pub fn get_mut<'g, C>(&'g mut self, id: &JobId) -> Result<JobMut<'a, 'g, R>, store::Error> {
        let job = self
            .raw