{"action":"created","issue":{"url":"https://api.github.com/repos/OmniLayer/omnicore/issues/233","labels_url":"https://api.github.com/repos/OmniLayer/omnicore/issues/233/labels{/name}","comments_url":"https://api.github.com/repos/OmniLayer/omnicore/issues/233/comments","events_url":"https://api.github.com/repos/OmniLayer/omnicore/issues/233/events","html_url":"https://github.com/OmniLayer/omnicore/pull/233","id":105993264,"number":233,"title":"Document results of JSON-RPC API","user":{"login":"dexX7","id":5836089,"avatar_url":"https://avatars.githubusercontent.com/u/5836089?v=3","gravatar_id":"","url":"https://api.github.com/users/dexX7","html_url":"https://github.com/dexX7","followers_url":"https://api.github.com/users/dexX7/followers","following_url":"https://api.github.com/users/dexX7/following{/other_user}","gists_url":"https://api.github.com/users/dexX7/gists{/gist_id}","starred_url":"https://api.github.com/users/dexX7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dexX7/subscriptions","organizations_url":"https://api.github.com/users/dexX7/orgs","repos_url":"https://api.github.com/users/dexX7/repos","events_url":"https://api.github.com/users/dexX7/events{/privacy}","received_events_url":"https://api.github.com/users/dexX7/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/OmniLayer/omnicore/labels/documentation","name":"documentation","color":"bfe5bf"},{"url":"https://api.github.com/repos/OmniLayer/omnicore/labels/status:%20ready","name":"status: ready","color":"009800"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":5,"created_at":"2015-09-11T11:38:03Z","updated_at":"2015-09-12T17:04:50Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/OmniLayer/omnicore/pulls/233","html_url":"https://github.com/OmniLayer/omnicore/pull/233","diff_url":"https://github.com/OmniLayer/omnicore/pull/233.diff","patch_url":"https://github.com/OmniLayer/omnicore/pull/233.patch"},"body":"Results were added for all documented API calls.\r\n\r\nThe text was directly adopted from the help descriptions, and wrapped into code blocks with JavaScript syntax highlighting, for a more appealing presentation.\r\n\r\nFor consistency, a few help descriptions were shifted."},"comment":{"url":"https://api.github.com/repos/OmniLayer/omnicore/issues/comments/139797540","html_url":"https://github.com/OmniLayer/omnicore/pull/233#issuecomment-139797540","issue_url":"https://api.github.com/repos/OmniLayer/omnicore/issues/233","id":139797540,"user":{"login":"msgilligan","id":61612,"avatar_url":"https://avatars.githubusercontent.com/u/61612?v=3","gravatar_id":"","url":"https://api.github.com/users/msgilligan","html_url":"https://github.com/msgilligan","followers_url":"https://api.github.com/users/msgilligan/followers","following_url":"https://api.github.com/users/msgilligan/following{/other_user}","gists_url":"https://api.github.com/users/msgilligan/gists{/gist_id}","starred_url":"https://api.github.com/users/msgilligan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/msgilligan/subscriptions","organizations_url":"https://api.github.com/users/msgilligan/orgs","repos_url":"https://api.github.com/users/msgilligan/repos","events_url":"https://api.github.com/users/msgilligan/events{/privacy}","received_events_url":"https://api.github.com/users/msgilligan/received_events","type":"User","site_admin":false},"created_at":"2015-09-12T17:04:50Z","updated_at":"2015-09-12T17:04:50Z","body":"The highlighting seems fine. \r\n\r\nThe things I'd most like to see are:\r\n1. A summary table showing all the calls, their parameters, and a description.\r\n1. The parameter information in table form so it's easier to scan.\r\n\r\nI specifically don't like how the parameters look like procedure calls themselves, e.g.:\r\n\r\n    endblock (number, optional)\r\n\r\nFor the Bitcoin RPCs I often find myself going to the bitcoin.it wiki for the [Full List](https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_calls_list#Full_list) and to the [Developer Reference](https://bitcoin.org/en/developer-reference#remote-procedure-calls-rpcs) for details on the individual calls. I do **not** like how they created one table for each parameter. I generally like the way JavaDoc produces a method summary with a link to the detailed information, though I'm not crazy about the default JavaDoc style sheets.\r\n\r\nI'm working on using Asciidoclet to document the `BitcoinClient` class (and eventually the `OmniClient` class) For each RPC method, I'd like to link back to documentation on the RPC itself.\r\n\r\nIt would be nice if there were a tool to generate docs for the RPCs themselves, but I'm not sure if there is anything good and JSON-RPC is kind of a special case. It might be worth spending a little time searching for one, though.\r\n\r\n\r\n"}}