{"action":"created","issue":{"url":"https://api.github.com/repos/elixir-lang/elixir/issues/7988","repository_url":"https://api.github.com/repos/elixir-lang/elixir","labels_url":"https://api.github.com/repos/elixir-lang/elixir/issues/7988/labels{/name}","comments_url":"https://api.github.com/repos/elixir-lang/elixir/issues/7988/comments","events_url":"https://api.github.com/repos/elixir-lang/elixir/issues/7988/events","html_url":"https://github.com/elixir-lang/elixir/pull/7988","id":344644713,"node_id":"MDExOlB1bGxSZXF1ZXN0MjAzOTkyNTYz","number":7988,"title":"Improve compile_doc warning","user":{"login":"goofansu","id":1143191,"node_id":"MDQ6VXNlcjExNDMxOTE=","avatar_url":"https://avatars2.githubusercontent.com/u/1143191?v=4","gravatar_id":"","url":"https://api.github.com/users/goofansu","html_url":"https://github.com/goofansu","followers_url":"https://api.github.com/users/goofansu/followers","following_url":"https://api.github.com/users/goofansu/following{/other_user}","gists_url":"https://api.github.com/users/goofansu/gists{/gist_id}","starred_url":"https://api.github.com/users/goofansu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/goofansu/subscriptions","organizations_url":"https://api.github.com/users/goofansu/orgs","repos_url":"https://api.github.com/users/goofansu/repos","events_url":"https://api.github.com/users/goofansu/events{/privacy}","received_events_url":"https://api.github.com/users/goofansu/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-07-25T23:42:57Z","updated_at":"2018-07-26T07:05:10Z","closed_at":null,"author_association":"NONE","pull_request":{"url":"https://api.github.com/repos/elixir-lang/elixir/pulls/7988","html_url":"https://github.com/elixir-lang/elixir/pull/7988","diff_url":"https://github.com/elixir-lang/elixir/pull/7988.diff","patch_url":"https://github.com/elixir-lang/elixir/pull/7988.patch"},"body":"`definition without a body` in the warning confused me when I upgraded 1.7.0 for my pheonix project.\r\n\r\nI found in other documents, it is called `function head` or `header`.\r\n\r\nFor example:\r\n\r\n1. https://github.com/elixir-lang/elixir/blob/691460a6e661f174476c69153776cba2f8a47341/lib/elixir/src/elixir_def.erl#L412-L426\r\n\r\n2. https://github.com/elixir-lang/elixir/blob/caa90b563ade4818a4e49b3e20149a44ff0c00c8/lib/elixir/pages/Writing%20Documentation.md#function-arguments\r\n\r\nOr else, is it better to add an example in the warning? Like `def foo(a, b)`"},"comment":{"url":"https://api.github.com/repos/elixir-lang/elixir/issues/comments/407998323","html_url":"https://github.com/elixir-lang/elixir/pull/7988#issuecomment-407998323","issue_url":"https://api.github.com/repos/elixir-lang/elixir/issues/7988","id":407998323,"node_id":"MDEyOklzc3VlQ29tbWVudDQwNzk5ODMyMw==","user":{"login":"josevalim","id":9582,"node_id":"MDQ6VXNlcjk1ODI=","avatar_url":"https://avatars0.githubusercontent.com/u/9582?v=4","gravatar_id":"","url":"https://api.github.com/users/josevalim","html_url":"https://github.com/josevalim","followers_url":"https://api.github.com/users/josevalim/followers","following_url":"https://api.github.com/users/josevalim/following{/other_user}","gists_url":"https://api.github.com/users/josevalim/gists{/gist_id}","starred_url":"https://api.github.com/users/josevalim/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/josevalim/subscriptions","organizations_url":"https://api.github.com/users/josevalim/orgs","repos_url":"https://api.github.com/users/josevalim/repos","events_url":"https://api.github.com/users/josevalim/events{/privacy}","received_events_url":"https://api.github.com/users/josevalim/received_events","type":"User","site_admin":false},"created_at":"2018-07-26T07:05:10Z","updated_at":"2018-07-26T07:05:10Z","author_association":"MEMBER","body":"Thanks! We were used to call it function head, but people found it confusing, and we generally agreed to call it definition without a body. Either way, I think including an example and going with a consistent name is the way to go."}}
{"actor":{"display_login":"josevalim"}}