Phoenix.Presence.get_by_key/2 typespec, return values, and documentation are inconsistent

[jaminthorns]

Environment

• Elixir version (elixir -v): 1.16.1
• Phoenix version (mix deps): 1.7.11
• Operating system: macOS 14.4 (23E214)

Actual behavior

Issue #4514 was never properly addressed. The commit 3c7f494 says that it addressed the issue, but it only updated the typespec of get_by_key/2 to something that is still inconsistent with the implementation and the example.

Expected behavior

I'll defer to the referenced issue for full explanation and possible solutions, since the author did a great job of breaking down the issue, and I agree with their proposed solutions.

[chrismccord]

If you think the docs are unclear, please send a PR, but this looks correct to me. The value returned matches the shape of presence() (note singular presence), and the function returns a list of those for that given id. Thanks!

[chrismccord]

Sorry, you're right the example just wrong :)