{"action":"created","issue":{"url":"https://api.github.com/repos/GiovineItalia/Gadfly.jl/issues/1161","repository_url":"https://api.github.com/repos/GiovineItalia/Gadfly.jl","labels_url":"https://api.github.com/repos/GiovineItalia/Gadfly.jl/issues/1161/labels{/name}","comments_url":"https://api.github.com/repos/GiovineItalia/Gadfly.jl/issues/1161/comments","events_url":"https://api.github.com/repos/GiovineItalia/Gadfly.jl/issues/1161/events","html_url":"https://github.com/GiovineItalia/Gadfly.jl/issues/1161","id":328878679,"node_id":"MDU6SXNzdWUzMjg4Nzg2Nzk=","number":1161,"title":"Use DocStringExtensions in Gadfly","user":{"login":"tlnagy","id":1661487,"node_id":"MDQ6VXNlcjE2NjE0ODc=","avatar_url":"https://avatars2.githubusercontent.com/u/1661487?v=4","gravatar_id":"","url":"https://api.github.com/users/tlnagy","html_url":"https://github.com/tlnagy","followers_url":"https://api.github.com/users/tlnagy/followers","following_url":"https://api.github.com/users/tlnagy/following{/other_user}","gists_url":"https://api.github.com/users/tlnagy/gists{/gist_id}","starred_url":"https://api.github.com/users/tlnagy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tlnagy/subscriptions","organizations_url":"https://api.github.com/users/tlnagy/orgs","repos_url":"https://api.github.com/users/tlnagy/repos","events_url":"https://api.github.com/users/tlnagy/events{/privacy}","received_events_url":"https://api.github.com/users/tlnagy/received_events","type":"User","site_admin":false},"labels":[{"id":108511521,"node_id":"MDU6TGFiZWwxMDg1MTE1MjE=","url":"https://api.github.com/repos/GiovineItalia/Gadfly.jl/labels/design-discussion","name":"design-discussion","color":"006b75","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2018-06-04T00:54:10Z","updated_at":"2018-07-20T11:51:59Z","closed_at":null,"author_association":"MEMBER","body":"[`DocStringExtensions.jl`](https://github.com/JuliaDocs/DocStringExtensions.jl) is a really nice self-contained package that allows us to have much more flexible and dynamic docstrings. I'm very wary of adding more dependencies to Gadfly, but this package would add no subdependencies (it only depends on `Compat` and `Base`). A couple examples of where we can leverage it:\r\n\r\n1) By using the automatically generated function signatures in the docstrings (so they don't get out sync) with the actual functions\r\n\r\n2) By unrolling the fields in a type (see https://github.com/GiovineItalia/Gadfly.jl/pull/1157/files#diff-9ec506bf78232ae17d082c22c2e66449R507). Currently, all those docs are hidden when you do\r\n`?Gadfly.Stat.density`, but could be unrolled with `DocStringExtension.jl`\r\n\r\nThoughts?"},"comment":{"url":"https://api.github.com/repos/GiovineItalia/Gadfly.jl/issues/comments/406578106","html_url":"https://github.com/GiovineItalia/Gadfly.jl/issues/1161#issuecomment-406578106","issue_url":"https://api.github.com/repos/GiovineItalia/Gadfly.jl/issues/1161","id":406578106,"node_id":"MDEyOklzc3VlQ29tbWVudDQwNjU3ODEwNg==","user":{"login":"bjarthur","id":1538268,"node_id":"MDQ6VXNlcjE1MzgyNjg=","avatar_url":"https://avatars2.githubusercontent.com/u/1538268?v=4","gravatar_id":"","url":"https://api.github.com/users/bjarthur","html_url":"https://github.com/bjarthur","followers_url":"https://api.github.com/users/bjarthur/followers","following_url":"https://api.github.com/users/bjarthur/following{/other_user}","gists_url":"https://api.github.com/users/bjarthur/gists{/gist_id}","starred_url":"https://api.github.com/users/bjarthur/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bjarthur/subscriptions","organizations_url":"https://api.github.com/users/bjarthur/orgs","repos_url":"https://api.github.com/users/bjarthur/repos","events_url":"https://api.github.com/users/bjarthur/events{/privacy}","received_events_url":"https://api.github.com/users/bjarthur/received_events","type":"User","site_admin":false},"created_at":"2018-07-20T11:51:59Z","updated_at":"2018-07-20T11:51:59Z","author_association":"CONTRIBUTOR","body":"i can see the value in DocStringExtensions. https://github.com/GiovineItalia/Gadfly.jl/pull/1173 proposes to use it."}}
{"actor":{"display_login":"bjarthur"}}