Skip to content

Commit

Permalink
Update RemoteSynchronizable documentation
Browse files Browse the repository at this point in the history
This concern was reverted in d045d1d to the previous implementation where the
client is explicitly set as a class variable rather than by a method
call, but it looks like the documentation still reflects the previous
way.

Similarly, it no longer uses lifecycle callbacks but relies on these
methods to be explicitly called.
  • Loading branch information
jackbot committed Feb 21, 2025
1 parent d8222b8 commit 0e631a3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions app/models/concerns/remote_synchronizable.rb
Original file line number Diff line number Diff line change
@@ -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
# ```
#
Expand Down

0 comments on commit 0e631a3

Please sign in to comment.