-
Notifications
You must be signed in to change notification settings - Fork 178
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
docs: ✏️ Sidekiq instrumentation options #824
docs: ✏️ Sidekiq instrumentation options #824
Conversation
instrumentation/sidekiq/README.md
Outdated
end | ||
``` | ||
|
||
|name|type|default|description| |
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.
✨ Thank you!
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.
Thank you for your contribution!
If you are curious and would be interested in helping us a little more in this area, I would be interested in seeing if we could somehow generate this markdown README as well as some yardoc that may appear here:
That way we could ensure our docs are up-to-date with the options we provide.
Is that something that would interest you?
@arielvalentin Thank you for confirming!
Sorry, I missed the mention of Yard in the Contribute guide. |
@arielvalentin I moved from README to Yard. |
Thank you for taking the time to do that! |
@kohbis Would you be interested and available to help us do the same for other instrumentations? |
@arielvalentin |
For users of Sidekiq instrumentation, I thought it would be nice to have a list of options and their uses.
So I added a (simple explain and format) table in the README ✏️
(At least no code reading required)
I improve any further explanations, items, or errors that are necessary.
If you don't need it, you can close it 🙏