Add documentations to concern methods [ci skip] #35886
Conversation
okuramasafumi
force-pushed
the
add-docs-to-concern
branch
from
266a79b
to
a6e01ff
Compare
|
I modified documentations so that (I believe) they're more useful for end users. |
okuramasafumi
force-pushed
the
add-docs-to-concern
branch
from
a6e01ff
to
dce3143
Compare
|
@kamipo Thank you for your comments. I force-pushed a commit following your advice. |
okuramasafumi
force-pushed
the
add-docs-to-concern
branch
from
dce3143
to
7b29bcd
Compare
| @@ -137,6 +140,23 @@ def included(base = nil, &block) | |||
| end | |||
| end | |||
|
|
|||
| # Define class methods from given block. | |||
| # You can define multiple +class_methods+ blocks. | |||
There was a problem hiding this comment.
hmm... actually multiple class_methods works, but seems it is not by design.
Is it worth to mention about multiple class_methods?
There was a problem hiding this comment.
Actually, I found it interesting that we can have multipleclass_methods while we cannot have multiple included.
Should it raise an exception when we have multiple class_methods, for the sake of symmetry?
There was a problem hiding this comment.
It seems worth discussing (I'd say less worth to disallow things aren't broken though).
There was a problem hiding this comment.
It might be good to put deprecation warning first when we have multiple class_methods.
If so, it's not a good idea to document multiple class_methods. What do you think?
There was a problem hiding this comment.
We don't always describe all behaviors in the API doc (e.g. #28490 (comment)).
Regardless of whether it is deprecated or not I don't think the multiple class_methods is valid use case.
There was a problem hiding this comment.
Alright, I'll remove multiple case from an example.
okuramasafumi
force-pushed
the
add-docs-to-concern
branch
from
7b29bcd
to
f0e5285
Compare
|
OK, I removed multiple |
| # | ||
| # private | ||
| # | ||
| # def bar; puts 'bar'; end |
There was a problem hiding this comment.
Can you follow the Coding Conventions?
Indent and no blank line after private/protected.
https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#write-your-code
| # end | ||
| # end | ||
| # | ||
| # Buzz = Class.new.include(Example) |
There was a problem hiding this comment.
Buzz = Class.new.include(Example) is not usual to me.
Can you use actual class Buzz?
okuramasafumi
force-pushed
the
add-docs-to-concern
branch
from
f0e5285
to
8dcce70
Compare
Summary
Add some documentations to concern methods (
includedandclass_methods).append_featuresis:nodoc:because users don't care about it.