Is this documentation outdated?

[joshuap]

The README and code docs for Honeybadger.notify say to pass the context as the second argument:

honeybadger-elixir/lib/honeybadger.ex

Line 44 in d051f07

Honeybadger.notify(exception, context, __STACKTRACE__)

...but it looks like the second argument is actually metadata, which expects a context key:

honeybadger-elixir/lib/honeybadger/notice.ex

Line 58 in c2dc311

|> Map.put(:context, Map.get(metadata, :context, %{}))

Should it be Honeybadger.notify(exception, context), or Honeybadger.notify(exception, %{context: context})? I may be forgetting how this works.

cc @rabidpraxis @sorentwo

[sorentwo]

@joshuap The second argument is the metadata and not the context. To pass in context you need the %{context: context} map.

[rabidpraxis]

@joshuap Notice.new expects a map with :context, but it looks like Honeybadger.notify will jam all metadata the into the context key if its not already present:

honeybadger-elixir/lib/honeybadger.ex

Lines 253 to 257 in 24edb30

	metadata_with_breadcrumbs =
	metadata
	|> Map.delete(:breadcrumbs)
	|> contextual_metadata()
	|> Map.put(:breadcrumbs, breadcrumbs)

honeybadger-elixir/lib/honeybadger.ex

Lines 428 to 435 in 24edb30

	defp contextual_metadata(%{context: _} = metadata) do
	metadata
	end
	defp contextual_metadata(metadata) do
	%{context: metadata}
	end
	end

[joshuap]

@rabidpraxis oh OK, so our docs are actually valid? Is there a method you prefer?

[rabidpraxis]

I'm not sure. I probably swing towards favoring the explicit version, just for readability sake.

[hypernumbers]

The README is - it tells you to go and watch an Elixir Sips screencast - and the link doesn't work

https://hexdocs.pm/honeybadger/readme.html

[gordonguthrie]

The README is - it tells you to go and watch an Elixir Sips screencast - and the link doesn't work

https://hexdocs.pm/honeybadger/readme.html

This is corrected in the github repo - so please ignore

[subzero10]

Yeah, the markdown is not rendered as expected in hexdocs. You'll be redirected to the screencast if you click on the html tag that appears to be an image:

But if you click on "Watch our screencast", which is right below, you'll be redirected to a login page. I will correct that to take you to the screencast.