{"action":"closed","issue":{"url":"https://api.github.com/repos/tensorflow/tensorflow/issues/618","repository_url":"https://api.github.com/repos/tensorflow/tensorflow","labels_url":"https://api.github.com/repos/tensorflow/tensorflow/issues/618/labels{/name}","comments_url":"https://api.github.com/repos/tensorflow/tensorflow/issues/618/comments","events_url":"https://api.github.com/repos/tensorflow/tensorflow/issues/618/events","html_url":"https://github.com/tensorflow/tensorflow/issues/618","id":123891693,"number":618,"title":"Strongly suggest to improve Tensorflow API document by adding examples","user":{"login":"JacobIsrael123","id":3758964,"avatar_url":"https://avatars.githubusercontent.com/u/3758964?v=3","gravatar_id":"","url":"https://api.github.com/users/JacobIsrael123","html_url":"https://github.com/JacobIsrael123","followers_url":"https://api.github.com/users/JacobIsrael123/followers","following_url":"https://api.github.com/users/JacobIsrael123/following{/other_user}","gists_url":"https://api.github.com/users/JacobIsrael123/gists{/gist_id}","starred_url":"https://api.github.com/users/JacobIsrael123/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JacobIsrael123/subscriptions","organizations_url":"https://api.github.com/users/JacobIsrael123/orgs","repos_url":"https://api.github.com/users/JacobIsrael123/repos","events_url":"https://api.github.com/users/JacobIsrael123/events{/privacy}","received_events_url":"https://api.github.com/users/JacobIsrael123/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/tensorflow/tensorflow/labels/contributions%20welcome","name":"contributions welcome","color":"009800"},{"url":"https://api.github.com/repos/tensorflow/tensorflow/labels/docs","name":"docs","color":"c7def8"}],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2015-12-25T17:42:04Z","updated_at":"2016-06-08T23:37:57Z","closed_at":"2016-06-08T23:37:57Z","body":"Dear contributors, \r\n        I think the document of tensorflow is not good enough overall. \r\n        I really like Python and Numpy's official document, since they are give very **detailed explanation** and **importantly each concept has simple code example to illustrate the meaning, which helps a lot for easier understanding**. \r\n       However, tensorflow's document does not contains such example for illustration and the explanation is not in detail. \r\n       For example, the document for \r\n      ```tf.nn.in_top_k(predictions, targets, k, name=None)``` \r\n       spend me much time to guess what does it mean. The formula in it is not trivial to understand. \r\n       We could see in the **issue post** in this project that many of them are regarding the specific use of some method/function. \r\n       To once for all resolve this problem, please consider to improve the the overall document in the Python document fashion, it is very important for the popularity of tensorflow among all other similar tools. \r\n       Thank you all for your contribution for this project. "}}
{"actor":{"display_login":"girving"}}