{"action":"created","issue":{"url":"https://api.github.com/repos/robotframework/robotframework/issues/2279","labels_url":"https://api.github.com/repos/robotframework/robotframework/issues/2279/labels{/name}","comments_url":"https://api.github.com/repos/robotframework/robotframework/issues/2279/comments","events_url":"https://api.github.com/repos/robotframework/robotframework/issues/2279/events","html_url":"https://github.com/robotframework/robotframework/issues/2279","id":123969767,"number":2279,"title":"Enhance public API documentation related to parts exposed to model modifiers and listeners","user":{"login":"pekkaklarck","id":114985,"avatar_url":"https://avatars.githubusercontent.com/u/114985?v=3","gravatar_id":"","url":"https://api.github.com/users/pekkaklarck","html_url":"https://github.com/pekkaklarck","followers_url":"https://api.github.com/users/pekkaklarck/followers","following_url":"https://api.github.com/users/pekkaklarck/following{/other_user}","gists_url":"https://api.github.com/users/pekkaklarck/gists{/gist_id}","starred_url":"https://api.github.com/users/pekkaklarck/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pekkaklarck/subscriptions","organizations_url":"https://api.github.com/users/pekkaklarck/orgs","repos_url":"https://api.github.com/users/pekkaklarck/repos","events_url":"https://api.github.com/users/pekkaklarck/events{/privacy}","received_events_url":"https://api.github.com/users/pekkaklarck/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/robotframework/robotframework/labels/enhancement","name":"enhancement","color":"84b6eb"},{"url":"https://api.github.com/repos/robotframework/robotframework/labels/prio-medium","name":"prio-medium","color":"ededed"},{"url":"https://api.github.com/repos/robotframework/robotframework/labels/rc%201","name":"rc 1","color":"ffffff"}],"state":"open","locked":false,"assignee":{"login":"pekkaklarck","id":114985,"avatar_url":"https://avatars.githubusercontent.com/u/114985?v=3","gravatar_id":"","url":"https://api.github.com/users/pekkaklarck","html_url":"https://github.com/pekkaklarck","followers_url":"https://api.github.com/users/pekkaklarck/followers","following_url":"https://api.github.com/users/pekkaklarck/following{/other_user}","gists_url":"https://api.github.com/users/pekkaklarck/gists{/gist_id}","starred_url":"https://api.github.com/users/pekkaklarck/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pekkaklarck/subscriptions","organizations_url":"https://api.github.com/users/pekkaklarck/orgs","repos_url":"https://api.github.com/users/pekkaklarck/repos","events_url":"https://api.github.com/users/pekkaklarck/events{/privacy}","received_events_url":"https://api.github.com/users/pekkaklarck/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/robotframework/robotframework/milestones/40","html_url":"https://github.com/robotframework/robotframework/milestones/3.0","labels_url":"https://api.github.com/repos/robotframework/robotframework/milestones/40/labels","id":1176901,"number":40,"title":"3.0","description":"","creator":{"login":"pekkaklarck","id":114985,"avatar_url":"https://avatars.githubusercontent.com/u/114985?v=3","gravatar_id":"","url":"https://api.github.com/users/pekkaklarck","html_url":"https://github.com/pekkaklarck","followers_url":"https://api.github.com/users/pekkaklarck/followers","following_url":"https://api.github.com/users/pekkaklarck/following{/other_user}","gists_url":"https://api.github.com/users/pekkaklarck/gists{/gist_id}","starred_url":"https://api.github.com/users/pekkaklarck/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pekkaklarck/subscriptions","organizations_url":"https://api.github.com/users/pekkaklarck/orgs","repos_url":"https://api.github.com/users/pekkaklarck/repos","events_url":"https://api.github.com/users/pekkaklarck/events{/privacy}","received_events_url":"https://api.github.com/users/pekkaklarck/received_events","type":"User","site_admin":false},"open_issues":4,"closed_issues":49,"state":"open","created_at":"2015-06-23T08:36:43Z","updated_at":"2015-12-27T09:30:27Z","due_on":null,"closed_at":null},"comments":1,"created_at":"2015-12-27T09:30:27Z","updated_at":"2015-12-28T16:27:29Z","closed_at":null,"body":"Robot Framework's programmatic API is documented at http://robot-framework.readthedocs.org. The documentation is not that comprehensive and could be enhanced in many ways. This issue covers enhancing the parts that are exposed to pre-run and pre-Rebot modifiers (added in RF 2.9, #1976) and listener v3 (added in RF 3.0, #1208). In practice this issue covers enhancing documentation of running and result model objects and the visitor interface."},"comment":{"url":"https://api.github.com/repos/robotframework/robotframework/issues/comments/167599080","html_url":"https://github.com/robotframework/robotframework/issues/2279#issuecomment-167599080","issue_url":"https://api.github.com/repos/robotframework/robotframework/issues/2279","id":167599080,"user":{"login":"pekkaklarck","id":114985,"avatar_url":"https://avatars.githubusercontent.com/u/114985?v=3","gravatar_id":"","url":"https://api.github.com/users/pekkaklarck","html_url":"https://github.com/pekkaklarck","followers_url":"https://api.github.com/users/pekkaklarck/followers","following_url":"https://api.github.com/users/pekkaklarck/following{/other_user}","gists_url":"https://api.github.com/users/pekkaklarck/gists{/gist_id}","starred_url":"https://api.github.com/users/pekkaklarck/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pekkaklarck/subscriptions","organizations_url":"https://api.github.com/users/pekkaklarck/orgs","repos_url":"https://api.github.com/users/pekkaklarck/repos","events_url":"https://api.github.com/users/pekkaklarck/events{/privacy}","received_events_url":"https://api.github.com/users/pekkaklarck/received_events","type":"User","site_admin":false},"created_at":"2015-12-28T16:27:29Z","updated_at":"2015-12-28T16:27:29Z","body":"Tasks related to this issue:\r\n\r\n- [ ] Review and enhance visitor documentation. On a quick look it seems to be in pretty good shape already.\r\n- [ ] Add links to related execution and result objects into User Guide's pre-run and pre-Rebot modifier sections.\r\n- [ ] Make sure all methods and attributes of running objects are documented. This includes also classes used by these objects.\r\n- [ ] Same as the above but with result objects."}}