Make README examples more "foolproof"

beam-telemetry / telemetry

Dynamic dispatching library for metrics and instrumentations.

https://hexdocs.pm/telemetry

Apache License 2.0

872 stars 66 forks source link

Closed nathanl closed 5 years ago

nathanl commented 5 years ago

Make clear that the first argument is a handler id that must be unique
Show matching on the ok atom return value so that duplicate ids do not cause a silent failure
Format the code examples across multiple lines so that scrolling isn't necessary
Add another link to the detailed documentation

nathanl commented 5 years ago

This foolproofing is courtesy of your friendly neighborhood fool. "Doing stuff wrong.. so YOU don't have to!"™ 😆

josevalim commented 5 years ago

:heart: :green_heart: :blue_heart: :yellow_heart: :purple_heart: