Add documentation about what is returned from RemoteSettingsService::Sync

Standard8 · Standard8 · commit 8098bc647d76 · 2026-02-04T14:52:59.000Z
diff --git a/components/remote_settings/src/lib.rs b/components/remote_settings/src/lib.rs
@@ -68,6 +68,9 @@ impl RemoteSettingsService {
     }
 
     /// Sync collections for all active clients
+    ///
+    /// The returned list is the list of collections for which updates were seen
+    /// and then synced.
     #[handle_error(Error)]
     pub fn sync(&self) -> ApiResult<Vec<String>> {
         self.internal.sync()

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,9 @@ impl RemoteSettingsService {`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`/// Sync collections for all active clients`
	`71`	`+ ///`
	`72`	`+ /// The returned list is the list of collections for which updates were seen`
	`73`	`+ /// and then synced.`
`71`	`74`	`#[handle_error(Error)]`
`72`	`75`	`pub fn sync(&self) -> ApiResult<Vec<String>> {`
`73`	`76`	`self.internal.sync()`