{"action":"created","issue":{"url":"https://api.github.com/repos/rust-lang/rust/issues/37500","repository_url":"https://api.github.com/repos/rust-lang/rust","labels_url":"https://api.github.com/repos/rust-lang/rust/issues/37500/labels{/name}","comments_url":"https://api.github.com/repos/rust-lang/rust/issues/37500/comments","events_url":"https://api.github.com/repos/rust-lang/rust/issues/37500/events","html_url":"https://github.com/rust-lang/rust/issues/37500","id":186338973,"number":37500,"title":"Misleading docs for an enum with struct variants","user":{"login":"mathstuf","id":97253,"avatar_url":"https://avatars.githubusercontent.com/u/97253?v=3","gravatar_id":"","url":"https://api.github.com/users/mathstuf","html_url":"https://github.com/mathstuf","followers_url":"https://api.github.com/users/mathstuf/followers","following_url":"https://api.github.com/users/mathstuf/following{/other_user}","gists_url":"https://api.github.com/users/mathstuf/gists{/gist_id}","starred_url":"https://api.github.com/users/mathstuf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mathstuf/subscriptions","organizations_url":"https://api.github.com/users/mathstuf/orgs","repos_url":"https://api.github.com/users/mathstuf/repos","events_url":"https://api.github.com/users/mathstuf/events{/privacy}","received_events_url":"https://api.github.com/users/mathstuf/received_events","type":"User","site_admin":false},"labels":[{"id":203738,"url":"https://api.github.com/repos/rust-lang/rust/labels/A-rustdoc","name":"A-rustdoc","color":"d7e102","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2016-10-31T17:01:07Z","updated_at":"2016-11-02T20:42:48Z","closed_at":null,"body":"Given this structure:\r\n\r\n```rust\r\npub enum OldTopicRemoval {\r\n    Obsoleted {\r\n        old_merge: StagedTopic,\r\n        replacement: Option<StagedTopic>,\r\n    },\r\n    Removed(StagedTopic),\r\n}\r\n```\r\n\r\nI'm seeing docs rendered as:\r\n\r\n![docs-enum](https://cloud.githubusercontent.com/assets/97253/19863197/9fa92942-9f69-11e6-99db-38b755cad90a.png)\r\n\r\nWhich makes it look like `Removed` is more closely related to the fields of `Obsoleted` rather than on the same level. It'd be nice if the fields for the `Obsoleted` variant fields were either indented somehow or collapsed with the description."},"comment":{"url":"https://api.github.com/repos/rust-lang/rust/issues/comments/257992669","html_url":"https://github.com/rust-lang/rust/issues/37500#issuecomment-257992669","issue_url":"https://api.github.com/repos/rust-lang/rust/issues/37500","id":257992669,"user":{"login":"GuillaumeGomez","id":3050060,"avatar_url":"https://avatars.githubusercontent.com/u/3050060?v=3","gravatar_id":"","url":"https://api.github.com/users/GuillaumeGomez","html_url":"https://github.com/GuillaumeGomez","followers_url":"https://api.github.com/users/GuillaumeGomez/followers","following_url":"https://api.github.com/users/GuillaumeGomez/following{/other_user}","gists_url":"https://api.github.com/users/GuillaumeGomez/gists{/gist_id}","starred_url":"https://api.github.com/users/GuillaumeGomez/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/GuillaumeGomez/subscriptions","organizations_url":"https://api.github.com/users/GuillaumeGomez/orgs","repos_url":"https://api.github.com/users/GuillaumeGomez/repos","events_url":"https://api.github.com/users/GuillaumeGomez/events{/privacy}","received_events_url":"https://api.github.com/users/GuillaumeGomez/received_events","type":"User","site_admin":false},"created_at":"2016-11-02T20:42:48Z","updated_at":"2016-11-02T20:42:48Z","body":"A tricky one. The problem just gets bigger if it has more \"sub-levels\". The output shouldn't be based on indentation therefore. I'm more in favor for bigger margin between the struct fields and the other variants. Also, it would be nice to replace \"Fields\" by something like \"Fields of `Obsoleted` variant\"."}}
{"actor":{"display_login":"GuillaumeGomez"}}