{"action":"created","issue":{"url":"https://api.github.com/repos/datacleaner/DataCleaner/issues/374","labels_url":"https://api.github.com/repos/datacleaner/DataCleaner/issues/374/labels{/name}","comments_url":"https://api.github.com/repos/datacleaner/DataCleaner/issues/374/comments","events_url":"https://api.github.com/repos/datacleaner/DataCleaner/issues/374/events","html_url":"https://github.com/datacleaner/DataCleaner/pull/374","id":68045853,"number":374,"title":"Feature/343 automatic reference documentation","user":{"login":"ClaudiaPHI","id":6339923,"avatar_url":"https://avatars.githubusercontent.com/u/6339923?v=3","gravatar_id":"","url":"https://api.github.com/users/ClaudiaPHI","html_url":"https://github.com/ClaudiaPHI","followers_url":"https://api.github.com/users/ClaudiaPHI/followers","following_url":"https://api.github.com/users/ClaudiaPHI/following{/other_user}","gists_url":"https://api.github.com/users/ClaudiaPHI/gists{/gist_id}","starred_url":"https://api.github.com/users/ClaudiaPHI/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ClaudiaPHI/subscriptions","organizations_url":"https://api.github.com/users/ClaudiaPHI/orgs","repos_url":"https://api.github.com/users/ClaudiaPHI/repos","events_url":"https://api.github.com/users/ClaudiaPHI/events{/privacy}","received_events_url":"https://api.github.com/users/ClaudiaPHI/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"ClaudiaPHI","id":6339923,"avatar_url":"https://avatars.githubusercontent.com/u/6339923?v=3","gravatar_id":"","url":"https://api.github.com/users/ClaudiaPHI","html_url":"https://github.com/ClaudiaPHI","followers_url":"https://api.github.com/users/ClaudiaPHI/followers","following_url":"https://api.github.com/users/ClaudiaPHI/following{/other_user}","gists_url":"https://api.github.com/users/ClaudiaPHI/gists{/gist_id}","starred_url":"https://api.github.com/users/ClaudiaPHI/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ClaudiaPHI/subscriptions","organizations_url":"https://api.github.com/users/ClaudiaPHI/orgs","repos_url":"https://api.github.com/users/ClaudiaPHI/repos","events_url":"https://api.github.com/users/ClaudiaPHI/events{/privacy}","received_events_url":"https://api.github.com/users/ClaudiaPHI/received_events","type":"User","site_admin":false},"milestone":null,"comments":5,"created_at":"2015-04-13T08:55:54Z","updated_at":"2015-04-21T09:59:32Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/datacleaner/DataCleaner/pulls/374","html_url":"https://github.com/datacleaner/DataCleaner/pull/374","diff_url":"https://github.com/datacleaner/DataCleaner/pull/374.diff","patch_url":"https://github.com/datacleaner/DataCleaner/pull/374.patch"},"body":"I am not sure about some things so please comment."},"comment":{"url":"https://api.github.com/repos/datacleaner/DataCleaner/issues/comments/94726513","html_url":"https://github.com/datacleaner/DataCleaner/pull/374#issuecomment-94726513","issue_url":"https://api.github.com/repos/datacleaner/DataCleaner/issues/374","id":94726513,"user":{"login":"kaspersorensen","id":291450,"avatar_url":"https://avatars.githubusercontent.com/u/291450?v=3","gravatar_id":"","url":"https://api.github.com/users/kaspersorensen","html_url":"https://github.com/kaspersorensen","followers_url":"https://api.github.com/users/kaspersorensen/followers","following_url":"https://api.github.com/users/kaspersorensen/following{/other_user}","gists_url":"https://api.github.com/users/kaspersorensen/gists{/gist_id}","starred_url":"https://api.github.com/users/kaspersorensen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kaspersorensen/subscriptions","organizations_url":"https://api.github.com/users/kaspersorensen/orgs","repos_url":"https://api.github.com/users/kaspersorensen/repos","events_url":"https://api.github.com/users/kaspersorensen/events{/privacy}","received_events_url":"https://api.github.com/users/kaspersorensen/received_events","type":"User","site_admin":false},"created_at":"2015-04-21T09:59:32Z","updated_at":"2015-04-21T09:59:32Z","body":"A few thing comes to the eye: The font is with serifs and certainly not the font we normally use in DC (Ubuntu).\r\n\r\nThe bullet list wrt. distributed seems strange. And I can think of many other aspects (and more to come in the future) that would be pluggable so I would not \"ask a question\" for each of them, but tag the documentation with the ones that apply. So for instance I would here have a \"Distributed execution possible\" tag. And to give examples of other tags: \"Analyze category\", \"Concurrent execution\", \"Analyzer\"/\"Transformer\",\"Filter\" etc.\r\n\r\nThe properties are laid out in a table and I think that does not scale very well. Rather I would make a paragraph about every property. Each property would also have many tags that could apply. That's why I think the table does not work - the 4 columns cannot fit in all the aspects that we want to eventually include. Example of property details/tags could be \"mapped to [property X]\", \"required\". \"Not negative\" (number), \"text/xml\" (string mime type) etc... If you look at the DataCleaner-api package you can find many annotations that optionally describe this stuff."}}