{"action":"closed","issue":{"url":"https://api.github.com/repos/phoenixframework/phoenix_guides/issues/442","repository_url":"https://api.github.com/repos/phoenixframework/phoenix_guides","labels_url":"https://api.github.com/repos/phoenixframework/phoenix_guides/issues/442/labels{/name}","comments_url":"https://api.github.com/repos/phoenixframework/phoenix_guides/issues/442/comments","events_url":"https://api.github.com/repos/phoenixframework/phoenix_guides/issues/442/events","html_url":"https://github.com/phoenixframework/phoenix_guides/issues/442","id":122394711,"number":442,"title":"Potential confusion when describing function plugs","user":{"login":"dmarkow","id":8009,"avatar_url":"https://avatars.githubusercontent.com/u/8009?v=3","gravatar_id":"","url":"https://api.github.com/users/dmarkow","html_url":"https://github.com/dmarkow","followers_url":"https://api.github.com/users/dmarkow/followers","following_url":"https://api.github.com/users/dmarkow/following{/other_user}","gists_url":"https://api.github.com/users/dmarkow/gists{/gist_id}","starred_url":"https://api.github.com/users/dmarkow/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmarkow/subscriptions","organizations_url":"https://api.github.com/users/dmarkow/orgs","repos_url":"https://api.github.com/users/dmarkow/repos","events_url":"https://api.github.com/users/dmarkow/events{/privacy}","received_events_url":"https://api.github.com/users/dmarkow/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/phoenixframework/phoenix_guides/labels/enhancement","name":"enhancement","color":"84b6eb"},{"url":"https://api.github.com/repos/phoenixframework/phoenix_guides/labels/help%20wanted","name":"help wanted","color":"159818"}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2015-12-15T23:46:40Z","updated_at":"2016-08-16T21:14:55Z","closed_at":"2016-08-16T21:14:55Z","body":"In the [Function Plug](https://github.com/phoenixframework/phoenix_guides/blob/master/DD_Plug.md#function-plugs) section there are some potentially confusing code blocks:\r\n\r\n- The first code block for `show/2` refers to several functions (`authenticate/1`, `find_message/1`, etc.) but doesn't actually show them. It should maybe either have a `...` like the code block above it to at least imply that there is more stuff in this module after `show/2`? Or maybe explicitly list out the code for those functions?\r\n-  Similarly, the second example for `show/2` is restructured into the multiple plugs which refer to those unlisted functions. For example, the new `find_message/2` function calls the original (unlisted) `find_message/1` function. This could be confusing to someone new to Phoenix (and Elixir), and explicitly showing the code for both `find_message/1` and `find_message/2` could be helpful.\r\n\r\nI will happily make a pull request for this but wanted to get some input on how verbose these code blocks should/shouldn't be first. Thanks!"}}
{"actor":{"display_login":"jeregrine"}}