{"action":"created","issue":{"url":"https://api.github.com/repos/ELVIS-Project/vis-framework/issues/319","repository_url":"https://api.github.com/repos/ELVIS-Project/vis-framework","labels_url":"https://api.github.com/repos/ELVIS-Project/vis-framework/issues/319/labels{/name}","comments_url":"https://api.github.com/repos/ELVIS-Project/vis-framework/issues/319/comments","events_url":"https://api.github.com/repos/ELVIS-Project/vis-framework/issues/319/events","html_url":"https://github.com/ELVIS-Project/vis-framework/issues/319","id":40736985,"number":319,"title":"Docstring code examples should execute","user":{"login":"crantila","id":760102,"avatar_url":"https://avatars.githubusercontent.com/u/760102?v=3","gravatar_id":"","url":"https://api.github.com/users/crantila","html_url":"https://github.com/crantila","followers_url":"https://api.github.com/users/crantila/followers","following_url":"https://api.github.com/users/crantila/following{/other_user}","gists_url":"https://api.github.com/users/crantila/gists{/gist_id}","starred_url":"https://api.github.com/users/crantila/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/crantila/subscriptions","organizations_url":"https://api.github.com/users/crantila/orgs","repos_url":"https://api.github.com/users/crantila/repos","events_url":"https://api.github.com/users/crantila/events{/privacy}","received_events_url":"https://api.github.com/users/crantila/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/ELVIS-Project/vis-framework/labels/Status:%20IN%20PROGRESS","name":"Status: IN PROGRESS","color":"cccccc"},{"url":"https://api.github.com/repos/ELVIS-Project/vis-framework/labels/Type:%20DOCUMENTATION","name":"Type: DOCUMENTATION","color":"207de5"}],"state":"open","locked":false,"assignee":{"login":"mborsodi","id":11529868,"avatar_url":"https://avatars.githubusercontent.com/u/11529868?v=3","gravatar_id":"","url":"https://api.github.com/users/mborsodi","html_url":"https://github.com/mborsodi","followers_url":"https://api.github.com/users/mborsodi/followers","following_url":"https://api.github.com/users/mborsodi/following{/other_user}","gists_url":"https://api.github.com/users/mborsodi/gists{/gist_id}","starred_url":"https://api.github.com/users/mborsodi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mborsodi/subscriptions","organizations_url":"https://api.github.com/users/mborsodi/orgs","repos_url":"https://api.github.com/users/mborsodi/repos","events_url":"https://api.github.com/users/mborsodi/events{/privacy}","received_events_url":"https://api.github.com/users/mborsodi/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/ELVIS-Project/vis-framework/milestones/34","html_url":"https://github.com/ELVIS-Project/vis-framework/milestones/Release%203.0","labels_url":"https://api.github.com/repos/ELVIS-Project/vis-framework/milestones/34/labels","id":1678257,"number":34,"title":"Release 3.0","description":"Everything that should be part of release 3.0.\r\n(All individual 3.0 release milestones need to be merged into this one milestone.)","creator":{"login":"musicus","id":1203470,"avatar_url":"https://avatars.githubusercontent.com/u/1203470?v=3","gravatar_id":"","url":"https://api.github.com/users/musicus","html_url":"https://github.com/musicus","followers_url":"https://api.github.com/users/musicus/followers","following_url":"https://api.github.com/users/musicus/following{/other_user}","gists_url":"https://api.github.com/users/musicus/gists{/gist_id}","starred_url":"https://api.github.com/users/musicus/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/musicus/subscriptions","organizations_url":"https://api.github.com/users/musicus/orgs","repos_url":"https://api.github.com/users/musicus/repos","events_url":"https://api.github.com/users/musicus/events{/privacy}","received_events_url":"https://api.github.com/users/musicus/received_events","type":"User","site_admin":false},"open_issues":20,"closed_issues":13,"state":"open","created_at":"2016-04-01T15:18:57Z","updated_at":"2016-05-18T14:11:25Z","due_on":"2016-08-05T04:00:00Z","closed_at":null},"comments":8,"created_at":"2014-08-20T19:44:36Z","updated_at":"2016-05-20T16:02:03Z","closed_at":null,"body":"The docstring code examples aren't executable code. They should be."},"comment":{"url":"https://api.github.com/repos/ELVIS-Project/vis-framework/issues/comments/220646965","html_url":"https://github.com/ELVIS-Project/vis-framework/issues/319#issuecomment-220646965","issue_url":"https://api.github.com/repos/ELVIS-Project/vis-framework/issues/319","id":220646965,"user":{"login":"crantila","id":760102,"avatar_url":"https://avatars.githubusercontent.com/u/760102?v=3","gravatar_id":"","url":"https://api.github.com/users/crantila","html_url":"https://github.com/crantila","followers_url":"https://api.github.com/users/crantila/followers","following_url":"https://api.github.com/users/crantila/following{/other_user}","gists_url":"https://api.github.com/users/crantila/gists{/gist_id}","starred_url":"https://api.github.com/users/crantila/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/crantila/subscriptions","organizations_url":"https://api.github.com/users/crantila/orgs","repos_url":"https://api.github.com/users/crantila/repos","events_url":"https://api.github.com/users/crantila/events{/privacy}","received_events_url":"https://api.github.com/users/crantila/received_events","type":"User","site_admin":false},"created_at":"2016-05-20T16:02:03Z","updated_at":"2016-05-20T16:02:03Z","body":"What did you just discuss?\r\n\r\nMy model for good API documentation, for a long time, has been Qt. See [this](https://doc.qt.io/qt-5/qml-qtwebengine-webenginehistory.html) as an example. The idea is this:\r\n- one-sentence description\r\n- parameter type and description\r\n- if the function raises any exceptions, mention this\r\n- further prose description, if required\r\n- an example, or some examples, depending on the complexity of the function"}}
{"actor":{"display_login":"crantila"}}