{"action":"created","issue":{"url":"https://api.github.com/repos/dsheets/codoc/issues/65","labels_url":"https://api.github.com/repos/dsheets/codoc/issues/65/labels{/name}","comments_url":"https://api.github.com/repos/dsheets/codoc/issues/65/comments","events_url":"https://api.github.com/repos/dsheets/codoc/issues/65/events","html_url":"https://github.com/dsheets/codoc/issues/65","id":57545037,"number":65,"title":"Region html structure","user":{"login":"dbuenzli","id":485596,"avatar_url":"https://avatars.githubusercontent.com/u/485596?v=3","gravatar_id":"","url":"https://api.github.com/users/dbuenzli","html_url":"https://github.com/dbuenzli","followers_url":"https://api.github.com/users/dbuenzli/followers","following_url":"https://api.github.com/users/dbuenzli/following{/other_user}","gists_url":"https://api.github.com/users/dbuenzli/gists{/gist_id}","starred_url":"https://api.github.com/users/dbuenzli/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbuenzli/subscriptions","organizations_url":"https://api.github.com/users/dbuenzli/orgs","repos_url":"https://api.github.com/users/dbuenzli/repos","events_url":"https://api.github.com/users/dbuenzli/events{/privacy}","received_events_url":"https://api.github.com/users/dbuenzli/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/dsheets/codoc/labels/enhancement","name":"enhancement","color":"84b6eb"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/dsheets/codoc/milestones/2","labels_url":"https://api.github.com/repos/dsheets/codoc/milestones/2/labels","id":938650,"number":2,"title":"beta","description":null,"creator":{"login":"dsheets","id":59918,"avatar_url":"https://avatars.githubusercontent.com/u/59918?v=3","gravatar_id":"","url":"https://api.github.com/users/dsheets","html_url":"https://github.com/dsheets","followers_url":"https://api.github.com/users/dsheets/followers","following_url":"https://api.github.com/users/dsheets/following{/other_user}","gists_url":"https://api.github.com/users/dsheets/gists{/gist_id}","starred_url":"https://api.github.com/users/dsheets/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dsheets/subscriptions","organizations_url":"https://api.github.com/users/dsheets/orgs","repos_url":"https://api.github.com/users/dsheets/repos","events_url":"https://api.github.com/users/dsheets/events{/privacy}","received_events_url":"https://api.github.com/users/dsheets/received_events","type":"User","site_admin":false},"open_issues":21,"closed_issues":1,"state":"open","created_at":"2015-01-16T14:42:25Z","updated_at":"2015-02-13T10:02:06Z","due_on":null,"closed_at":null},"comments":7,"created_at":"2015-02-13T01:06:28Z","updated_at":"2015-02-13T15:09:40Z","closed_at":null,"body":"Currently we have something like this:\r\n\r\n```html\r\n<div class=\"region\" id=\"/val:decoder_col\">\r\n  <a href=\"index.html#/val:decoder_col\" class=\"anchor\">#</a>\r\n  <div class=\"val\">\r\n    <span class=\"keyword\">val</span> decoder_col : <a href=\"index.html#/type:decoder\">decoder</>\r\n    <span class=\"rarr\"><span>-&gt;</span></span> int\r\n    <div class=\"doc\">    \r\n      <p><code>decoder_col d</code> is the column number of  ....</p>\r\n    </div>\r\n  </div>\r\n</div>\r\n```\r\nwhich is a little bit messy for styling. I think you should delimitate the OCaml definition in a `div`. \r\n\r\nHere are a few alternatives. This one just keeps the same structure and wraps the def:\r\n```html\r\n<div class=\"region\" id=\"/val:decoder_col\">\r\n  <a href=\"index.html#/val:decoder_col\" class=\"anchor\">#</a>\r\n  <div class=\"val\">\r\n    <div class=\"def\">\r\n      <span class=\"keyword\">val</span> decoder_col : <a href=\"index.html#/type:decoder\">decoder</>\r\n      <span class=\"rarr\"><span>-&gt;</span></span> int\r\n    </div>\r\n    <div class=\"doc\">\r\n    <p><code>decoder_col d</code> is the column number of  ....</p>\r\n    </div>\r\n  </div>\r\n</div>\r\n```\r\nbut to be honest that's too much nesting for my taste. I would prefer something flatter like:\r\n\r\n```html\r\n\r\n<div class=\"region val\" id=\"/val:decoder_col\">\r\n  <a href=\"index.html#/val:decoder_col\" class=\"anchor\">#</a>\r\n  <div class=\"def\">\r\n    <span class=\"keyword\">val</span> decoder_col : <a href=\"index.html#/type:decoder\">decoder</>\r\n    <span class=\"rarr\"><span>-&gt;</span></span> int\r\n  </div>\r\n  <div class=\"doc\">\r\n    <p><code>decoder_col d</code> is the column number of  ....</p>\r\n  </div>\r\n</div>\r\n```\r\nnote that the `val` class attribution now matches where you did put the `val:` id which feels right to me. \r\n\r\nTwo other things with respect to what we see here:\r\n\r\n1. I wouldn't generate these `#` in the output of anchors. Those can be added with CCS. \r\n2. There's a needless unclassifed `span` around  `-&gt;`\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/dsheets/codoc/issues/comments/74267556","html_url":"https://github.com/dsheets/codoc/issues/65#issuecomment-74267556","issue_url":"https://api.github.com/repos/dsheets/codoc/issues/65","id":74267556,"user":{"login":"dbuenzli","id":485596,"avatar_url":"https://avatars.githubusercontent.com/u/485596?v=3","gravatar_id":"","url":"https://api.github.com/users/dbuenzli","html_url":"https://github.com/dbuenzli","followers_url":"https://api.github.com/users/dbuenzli/followers","following_url":"https://api.github.com/users/dbuenzli/following{/other_user}","gists_url":"https://api.github.com/users/dbuenzli/gists{/gist_id}","starred_url":"https://api.github.com/users/dbuenzli/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbuenzli/subscriptions","organizations_url":"https://api.github.com/users/dbuenzli/orgs","repos_url":"https://api.github.com/users/dbuenzli/repos","events_url":"https://api.github.com/users/dbuenzli/events{/privacy}","received_events_url":"https://api.github.com/users/dbuenzli/received_events","type":"User","site_admin":false},"created_at":"2015-02-13T15:09:40Z","updated_at":"2015-02-13T15:09:40Z","body":"Ha, I was also thinking about that over lunch. "}}