small qol update to :telemetry.attach/4 docs#126
Open
ethangunderson wants to merge 2 commits intobeam-telemetry:mainfrom
Open
small qol update to :telemetry.attach/4 docs#126ethangunderson wants to merge 2 commits intobeam-telemetry:mainfrom
ethangunderson wants to merge 2 commits intobeam-telemetry:mainfrom
Conversation
Contributor
|
I think it might be worth improving the error message too. In Elixir, we've often done this by removing the arity from the |
Contributor
Author
|
@whatyouhide I like that suggestion. Do you want me to make that change in this PR? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This has come up a few times for us. It's not always obvious that the function supplied to attach must be
/4. When supplying something else you get an exception message that also doesn't reveal the problem.I'm hoping that adding a slightly more explicit explanation of the function argument in function doc will help some people avoid this confusion in the future.