-
Notifications
You must be signed in to change notification settings - Fork 21.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
Update documentation for QueueAdapters::lookup #20371
Conversation
I'm not sure about nodoc'ing it. While it's true it's only used one place internally, other people might use it in their apps because it's been public API. Also with the nodoc people will only see the comment right next to the implementation and I feel like that's communicative enough in and of itself. |
Agree with @kaspth either we |
be009a8
to
f017b53
Compare
Let's add an example too, since now people don't have the implementation next to them. |
f017b53
to
11aceda
Compare
@kaspth added simple example for this method. What do you think? |
# Returns adapter for specified name. For example, this enables to perform | ||
# job with specific adapter: | ||
# | ||
# Adapter = ActiveJob::QueueAdapters.lookup(:sidekiq) |
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.
I don't think the variable assignment is necessary
11aceda
to
528efcb
Compare
Update documentation for QueueAdapters::lookup [ci skip]
Thank you 💛 |
@davydovanton Nice ❤️ |
I added simple documentation for method and also added
:nodoc:
because this method called only in privateQueueAdapter::interpret_adapter
./cc @kaspth