Skip to content
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

Potential problem with documentation #99

Closed
SLsthompson opened this issue Apr 5, 2018 · 2 comments
Closed

Potential problem with documentation #99

SLsthompson opened this issue Apr 5, 2018 · 2 comments

Comments

@SLsthompson
Copy link

SLsthompson commented Apr 5, 2018

In the documentation (https://hexdocs.pm/phoenix_pubsub/Phoenix.Tracker.html) under the heading "Implementing a Tracker" where it does:

defmodule MyTracker do
  @behavior Phoenix.Tracker
  ...

It then goes on to define a start_link that calls GenServer.start_link

Should that sample code not include use GenServer as well? Without it, the module does not define child_spec and, like #94, problems with the deprecation of Supervisor.Spec ensue.

(if the change is appropriate, I would be happy to put together a pull request to make it)

@chrismccord
Copy link
Member

Please send a PR to include child_spec in the example under that heading. Thanks!

@josevalim
Copy link
Member

Fixed, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants