Merge pull request #1387 from alphagov/remote-sync-doc

Update RemoteSynchronizable documentation
alphagov · Feb 21, 2025 · dba3549 · dba3549
2 parents d8222b8 + 0e631a3
commit dba3549
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/app/models/concerns/remote_synchronizable.rb b/app/models/concerns/remote_synchronizable.rb
@@ -1,11 +1,11 @@
-# Enhances a model with lifecycle callbacks to synchronise it with a remote resource using a client
+# Enhances a model with methods to synchronise it with a remote resource using a client
 # class (conventionally located in `app/clients/`).
 #
 # Example:
 # ```ruby
 # class Foo < ApplicationRecord
 #   include RemoteSynchronizable
-#   remote_synchronize with: BarApi::FooClient
+#   self.remote_synchronizable_client_class = BarApi::FooClient
 # end
 # ```
 #