rename subscribe_to_updates() to updater() (#792)

paritytech · Jan 18, 2023 · 8ef8063 · 8ef8063
1 parent e036087
commit 8ef8063
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/examples/examples/subscribe_runtime_updates.rs b/examples/examples/subscribe_runtime_updates.rs
@@ -25,7 +25,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     // Start a new tokio task to perform the runtime updates while
     // utilizing the API for other use cases.
-    let update_client = api.subscribe_to_updates();
+    let update_client = api.updater();
     tokio::spawn(async move {
         let result = update_client.perform_runtime_updates().await;
         println!("Runtime update failed with result={:?}", result);

diff --git a/subxt/src/client/online_client.rs b/subxt/src/client/online_client.rs
@@ -123,15 +123,15 @@ impl<T: Config> OnlineClient<T> {
     ///
     /// // high level API.
     ///
-    /// let update_task = client.subscribe_to_updates();
+    /// let update_task = client.updater();
     /// tokio::spawn(async move {
     ///     update_task.perform_runtime_updates().await;
     /// });
     ///
     ///
     /// // low level API.
     ///
-    /// let updater = client.subscribe_to_updates();
+    /// let updater = client.updater();
     /// tokio::spawn(async move {
     ///     let mut update_stream = updater.runtime_updates().await.unwrap();
     ///
@@ -150,7 +150,7 @@ impl<T: Config> OnlineClient<T> {
     /// });
     /// # }
     /// ```
-    pub fn subscribe_to_updates(&self) -> ClientRuntimeUpdater<T> {
+    pub fn updater(&self) -> ClientRuntimeUpdater<T> {
         ClientRuntimeUpdater(self.clone())
     }
 
@@ -234,7 +234,7 @@ impl<T: Config> OnlineClientT<T> for OnlineClient<T> {
     }
 }
 
-/// Client wrapper for performing runtime updates. See [`OnlineClient::subscribe_to_updates()`]
+/// Client wrapper for performing runtime updates. See [`OnlineClient::updater()`]
 /// for example usage.
 pub struct ClientRuntimeUpdater<T: Config>(OnlineClient<T>);