-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Serialization and Cache Documentation #1260
Conversation
yay documentation! omg :-) |
@bf4 Any specific reason not to break it into 3 PRs? |
No, just kept writing and sometimes more is harder to review. B mobile phone
|
@@ -127,6 +199,9 @@ def self.get_serializer_for(klass) | |||
attr_accessor :object, :root, :scope | |||
class_attribute :_type, instance_writer: false | |||
|
|||
# `scope_name` is set as :current_user by default in the controller. | |||
# If the instance does not have a method nameed `scope_name`, it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"nameed" -> "named"
class << self | ||
attr_accessor :_attributes | ||
attr_accessor :_attributes_keys | ||
# Hashes contents of file for +_cache_digest+ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you elaborate (just for my personal understanding) on which practical situations the error is thrown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry I didn't call this out better. I included it in the PR description for the change: #1176
c678a3a
to
60df36b
Compare
end | ||
|
||
serializer.class_attribute :_cache # @api private : the cache object | ||
serializer.class_attribute :_fragmented # @api private : |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing description
A few minor comments but great work nonetheless. |
9648a9c
to
274cb66
Compare
Look good? |
omg, yes. |
Serialization and Cache Documentation
(other work extracted into #1271 #1272)