{"action":"created","issue":{"url":"https://api.github.com/repos/angular/material2/issues/10468","repository_url":"https://api.github.com/repos/angular/material2","labels_url":"https://api.github.com/repos/angular/material2/issues/10468/labels{/name}","comments_url":"https://api.github.com/repos/angular/material2/issues/10468/comments","events_url":"https://api.github.com/repos/angular/material2/issues/10468/events","html_url":"https://github.com/angular/material2/issues/10468","id":306240601,"number":10468,"title":"docs(snackbar): Add description for MatSnackBarHorizontalPosition and MatSnackBarVerticalPosition","user":{"login":"julianobrasil","id":25405143,"avatar_url":"https://avatars1.githubusercontent.com/u/25405143?v=4","gravatar_id":"","url":"https://api.github.com/users/julianobrasil","html_url":"https://github.com/julianobrasil","followers_url":"https://api.github.com/users/julianobrasil/followers","following_url":"https://api.github.com/users/julianobrasil/following{/other_user}","gists_url":"https://api.github.com/users/julianobrasil/gists{/gist_id}","starred_url":"https://api.github.com/users/julianobrasil/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/julianobrasil/subscriptions","organizations_url":"https://api.github.com/users/julianobrasil/orgs","repos_url":"https://api.github.com/users/julianobrasil/repos","events_url":"https://api.github.com/users/julianobrasil/events{/privacy}","received_events_url":"https://api.github.com/users/julianobrasil/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2018-03-18T13:31:33Z","updated_at":"2018-03-19T16:10:21Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"#### Bug, feature request, or proposal:\r\nRequest: apparently the docs generator doesn't take code comments associated with types definitions and interfaces to the docs site. So there should be some topic on the overview tab describing the possible values for  `MatSnackBarHorizontalPosition` and `MatSnackBarVerticalPosition`.\r\n\r\n#### What is the expected behavior?\r\nFind explanation about the possible values for `MatSnackBarHorizontalPosition` and `MatSnackBarVerticalPosition` in the docs site.\r\n\r\n#### What is the current behavior?\r\nYou must read the source code or rely on IDE features to know the possible values.\r\n\r\nhttps://github.com/angular/material2/blob/c28549d088c4462bf64078db5442a123542bf1be/src/lib/snack-bar/snack-bar-config.ts#L16-L20\r\n\r\nGenerally speaking the automatic document generation should include types and interfaces documentation comments in the API tab."},"comment":{"url":"https://api.github.com/repos/angular/material2/issues/comments/374268563","html_url":"https://github.com/angular/material2/issues/10468#issuecomment-374268563","issue_url":"https://api.github.com/repos/angular/material2/issues/10468","id":374268563,"user":{"login":"atinybeardedman","id":7054056,"avatar_url":"https://avatars2.githubusercontent.com/u/7054056?v=4","gravatar_id":"","url":"https://api.github.com/users/atinybeardedman","html_url":"https://github.com/atinybeardedman","followers_url":"https://api.github.com/users/atinybeardedman/followers","following_url":"https://api.github.com/users/atinybeardedman/following{/other_user}","gists_url":"https://api.github.com/users/atinybeardedman/gists{/gist_id}","starred_url":"https://api.github.com/users/atinybeardedman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/atinybeardedman/subscriptions","organizations_url":"https://api.github.com/users/atinybeardedman/orgs","repos_url":"https://api.github.com/users/atinybeardedman/repos","events_url":"https://api.github.com/users/atinybeardedman/events{/privacy}","received_events_url":"https://api.github.com/users/atinybeardedman/received_events","type":"User","site_admin":false},"created_at":"2018-03-19T16:10:21Z","updated_at":"2018-03-19T16:10:21Z","author_association":"NONE","body":"That's a fair point. I did look and see that it was only being used in this file and that's why I raised it as a question. So then the docs just need to support showing these types that aren't part of the exported class of that file but used by it."}}
{"actor":{"display_login":"atinybeardedman"}}