sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Elixir docs for the Add Context section don't match how the library works, or the library is out of date

Open hexpunk opened this issue 5 years ago • 3 comments

Issue

This an issue with:

Platform/SDK documentation for Elixir, specifically the Add Context section.

Description

  • The documentation mentions in the Structured Content section to use the set_context function. However, that function is private in the Sentry lib and can't be called directly in my code.

  • The Structured Content section is missing a code example.

  • Since I couldn't use set_context directly, I chose to use set_extra_context instead. However, the Additional Data section of the documentation says:

    Additional Data is deprecated in favor of structured contexts and should be avoided when possible.

    The set_extra_context function is not marked as deprecated in the code.

  • The Additional Data section refers to the set_extra_context function as set_extra, which is incorrect.

Suggested Solution

Either the documentation should be updated to match how the Elixir library seems intended to be used or the Elixir library should be updated to match how the other language libraries work.

hexpunk avatar Mar 08 '21 21:03 hexpunk

Thanks @JayAndCatchFire, routing to @getsentry/team-webplatform for triage.

chadwhitacre avatar Mar 09 '21 14:03 chadwhitacre

@mitchellhenke would you mind having a look at this? Thanks!

rhcarvalho avatar Mar 22 '21 09:03 rhcarvalho

How does this work again? I'm not seeing extra information show up in Sentry.

dustinfarris avatar Mar 23 '23 17:03 dustinfarris