{"action":"created","issue":{"url":"https://api.github.com/repos/slyrz/mango/issues/3","labels_url":"https://api.github.com/repos/slyrz/mango/issues/3/labels{/name}","comments_url":"https://api.github.com/repos/slyrz/mango/issues/3/comments","events_url":"https://api.github.com/repos/slyrz/mango/issues/3/events","html_url":"https://github.com/slyrz/mango/issues/3","id":57406769,"number":3,"title":"Optional rendering using no markup.","user":{"login":"mewmew","id":1414531,"avatar_url":"https://avatars.githubusercontent.com/u/1414531?v=3","gravatar_id":"","url":"https://api.github.com/users/mewmew","html_url":"https://github.com/mewmew","followers_url":"https://api.github.com/users/mewmew/followers","following_url":"https://api.github.com/users/mewmew/following{/other_user}","gists_url":"https://api.github.com/users/mewmew/gists{/gist_id}","starred_url":"https://api.github.com/users/mewmew/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mewmew/subscriptions","organizations_url":"https://api.github.com/users/mewmew/orgs","repos_url":"https://api.github.com/users/mewmew/repos","events_url":"https://api.github.com/users/mewmew/events{/privacy}","received_events_url":"https://api.github.com/users/mewmew/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-02-12T01:57:19Z","updated_at":"2015-02-16T15:37:39Z","closed_at":"2015-02-16T15:23:59Z","body":"First of, thanks for a great tool! It fits perfectly with the `go generate` command.\r\n\r\nIt would be great if markup rendering was optional, specifically so that rendering issues caused by it can be mitigated. I tried to use `mango` to generate a man page for https://github.com/mewrev/ll2dot but unintentional markup (e.g. the presence of `*`) in the comments caused rendering issues. Notice that the text was cut short since the `.` after the second `*` in `*.ll` was placed on a new line and was thus treated as a man command rather than plain text.\r\n\r\n```shell\r\nmango ll2dot.go\r\n```\r\n\r\nDoc comment:\r\n```go\r\n// ll2dot is a tool which creates control flow graphs of LLVM IR assembly files\r\n// (e.g. *.ll -> *.dot). The output is a set of GraphViz DOT files, each\r\n// representing the control flow graph of a function using one node per basic\r\n// block.\r\n//\r\n// For a source file \"foo.ll\" containing the functions \"bar\" and \"baz\" the\r\n// following DOT files will be created:\r\n//\r\n//    foo_graphs/bar.dot\r\n//    foo_graphs/baz.dot\r\npackage main\r\n```\r\n\r\nOutput:\r\n```man\r\n.TH \"LL2DOT\" 1 \"2015-02-12\" \"Ll2dot\" \"Ll2dot Manual\"\r\n.SH \"NAME\"\r\nll2dot is a tool which creates control flow graphs of LLVM IR assembly files\r\n(e.g.\r\n.B \".ll -> \"\r\n.dot). The output is a set of GraphViz DOT files, each\r\nrepresenting the control flow graph of a function using one node per basic\r\nblock.\r\n.PP\r\nFor a source file \"foo.ll\" containing the functions \"bar\" and \"baz\" the\r\nfollowing DOT files will be created:\r\n.PP\r\nfoo\r\ngraphs/bar.dot\r\nfoo\r\ngraphs/baz.dot\r\n.PP\r\n.SH \"SYNOPSIS\"\r\nll2dot\r\n.I \"[option...]\"\r\n.I \"[argument...]\"\r\n.PP\r\n.SH \"OPTIONS\"\r\n.B \"-f\"\r\n.RS 4\r\nForce overwrite existing graph directories.\r\n.RE\r\n.PP\r\n.B \"-funcs\"\r\n<string>\r\n.RS 4\r\nComma separated list of functions to parse (e.g. \"foo,bar\").\r\n.RE\r\n.PP\r\n.B \"-img\"\r\n.RS 4\r\nGenerate an image representation of the CFG.\r\n.RE\r\n.PP\r\n.B \"-q\"\r\n.RS 4\r\nSuppress non-error messages.\r\n.RE\r\n.PP\r\n```\r\n\r\n* Incorrect rendering caused by unintentional markup.\r\n![Incorrect rendering](https://i.imgur.com/NRXX2rp.png)\r\n\r\n* Plain text rendering.\r\n![Plain text rendering](https://i.imgur.com/l8dQGNz.png)"},"comment":{"url":"https://api.github.com/repos/slyrz/mango/issues/comments/74526303","html_url":"https://github.com/slyrz/mango/issues/3#issuecomment-74526303","issue_url":"https://api.github.com/repos/slyrz/mango/issues/3","id":74526303,"user":{"login":"slyrz","id":6135391,"avatar_url":"https://avatars.githubusercontent.com/u/6135391?v=3","gravatar_id":"","url":"https://api.github.com/users/slyrz","html_url":"https://github.com/slyrz","followers_url":"https://api.github.com/users/slyrz/followers","following_url":"https://api.github.com/users/slyrz/following{/other_user}","gists_url":"https://api.github.com/users/slyrz/gists{/gist_id}","starred_url":"https://api.github.com/users/slyrz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/slyrz/subscriptions","organizations_url":"https://api.github.com/users/slyrz/orgs","repos_url":"https://api.github.com/users/slyrz/repos","events_url":"https://api.github.com/users/slyrz/events{/privacy}","received_events_url":"https://api.github.com/users/slyrz/received_events","type":"User","site_admin":false},"created_at":"2015-02-16T15:37:39Z","updated_at":"2015-02-16T15:37:39Z","body":"Hi there, it's nice to hear that you like this tool. When I wrote it, I completely\r\nmissed that the markup might clash with the users comments. Your new plain command line flag is a nice way of avoiding such issues. Thanks!"}}