{"action":"created","issue":{"url":"https://api.github.com/repos/graphql/graphiql/issues/169","repository_url":"https://api.github.com/repos/graphql/graphiql","labels_url":"https://api.github.com/repos/graphql/graphiql/issues/169/labels{/name}","comments_url":"https://api.github.com/repos/graphql/graphiql/issues/169/comments","events_url":"https://api.github.com/repos/graphql/graphiql/issues/169/events","html_url":"https://github.com/graphql/graphiql/issues/169","id":177914798,"number":169,"title":"Show inline field description in documentation explorer","user":{"login":"OlegIlyenko","id":156569,"avatar_url":"https://avatars.githubusercontent.com/u/156569?v=3","gravatar_id":"","url":"https://api.github.com/users/OlegIlyenko","html_url":"https://github.com/OlegIlyenko","followers_url":"https://api.github.com/users/OlegIlyenko/followers","following_url":"https://api.github.com/users/OlegIlyenko/following{/other_user}","gists_url":"https://api.github.com/users/OlegIlyenko/gists{/gist_id}","starred_url":"https://api.github.com/users/OlegIlyenko/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/OlegIlyenko/subscriptions","organizations_url":"https://api.github.com/users/OlegIlyenko/orgs","repos_url":"https://api.github.com/users/OlegIlyenko/repos","events_url":"https://api.github.com/users/OlegIlyenko/events{/privacy}","received_events_url":"https://api.github.com/users/OlegIlyenko/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-09-19T22:27:27Z","updated_at":"2016-09-20T01:25:19Z","closed_at":null,"body":"At the moment fields look like this:\r\n\r\n![graphiql-fields](https://cloud.githubusercontent.com/assets/156569/18650838/d000ecb4-7ec7-11e6-95cf-e32957d8f4cd.png)\r\n\r\nIn contrast, enum values, for instance, which have an inline documentation for all of the values:\r\n\r\n![graphiql-enum-description](https://cloud.githubusercontent.com/assets/156569/18650855/ee726fa6-7ec7-11e6-93f8-60a31976c3c1.png)\r\n\r\nI find it very helpful to see the documentation for all of the fields or enum values in one view, especially when I'm trying to learn new API.\r\n\r\nSo my suggestion is display descriptions inline for fields as well:\r\n\r\n![graphiql-fields-description](https://cloud.githubusercontent.com/assets/156569/18650918/46c4ca28-7ec8-11e6-85bd-fb1f9be7ce34.png)\r\n\r\nThis raises a concern: I guess field descriptions tend to have much more information in them than an enum values. I can also imagine putting an example code snippet in the description. Maybe in this case we can truncate the description and show only a first paragraph or something along these lines?\r\n\r\nI would be really interested to know your opinion on this :)"},"comment":{"url":"https://api.github.com/repos/graphql/graphiql/issues/comments/248176239","html_url":"https://github.com/graphql/graphiql/issues/169#issuecomment-248176239","issue_url":"https://api.github.com/repos/graphql/graphiql/issues/169","id":248176239,"user":{"login":"asiandrummer","id":1537569,"avatar_url":"https://avatars.githubusercontent.com/u/1537569?v=3","gravatar_id":"","url":"https://api.github.com/users/asiandrummer","html_url":"https://github.com/asiandrummer","followers_url":"https://api.github.com/users/asiandrummer/followers","following_url":"https://api.github.com/users/asiandrummer/following{/other_user}","gists_url":"https://api.github.com/users/asiandrummer/gists{/gist_id}","starred_url":"https://api.github.com/users/asiandrummer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/asiandrummer/subscriptions","organizations_url":"https://api.github.com/users/asiandrummer/orgs","repos_url":"https://api.github.com/users/asiandrummer/repos","events_url":"https://api.github.com/users/asiandrummer/events{/privacy}","received_events_url":"https://api.github.com/users/asiandrummer/received_events","type":"User","site_admin":false},"created_at":"2016-09-20T01:25:19Z","updated_at":"2016-09-20T01:25:19Z","body":"@OlegIlyenko - I think what you have in mind is great. We can also do an expand/collapse style of inlined descriptions, but showing the first paragraph (or a sentence or two really) if it gets too long sounds like a great start.\r\n\r\nSomething to keep in mind is that `DocExplorer` doesn't limit the number of fields to be shown in the `div`, so if a type defines some large number of fields then the browser might suffer. Obviously this issue exists even without the description texts, and we should probably limit the number of field definitions to be shown in the type documentation to a reasonable number, but this sounds like a whole another issue to track.\r\n\r\n@leebyron and I were talking about something similar to this (in context of `deprecationReason`) - cc-ing since I'd love to get Lee's input as well ;)"}}
{"actor":{"display_login":"asiandrummer"}}