{"action":"closed","issue":{"url":"https://api.github.com/repos/AlexMili/torch-dataframe/issues/10","repository_url":"https://api.github.com/repos/AlexMili/torch-dataframe","labels_url":"https://api.github.com/repos/AlexMili/torch-dataframe/issues/10/labels{/name}","comments_url":"https://api.github.com/repos/AlexMili/torch-dataframe/issues/10/comments","events_url":"https://api.github.com/repos/AlexMili/torch-dataframe/issues/10/events","html_url":"https://github.com/AlexMili/torch-dataframe/issues/10","id":147210812,"number":10,"title":"API - documentation","user":{"login":"gforge","id":2198913,"avatar_url":"https://avatars.githubusercontent.com/u/2198913?v=3","gravatar_id":"","url":"https://api.github.com/users/gforge","html_url":"https://github.com/gforge","followers_url":"https://api.github.com/users/gforge/followers","following_url":"https://api.github.com/users/gforge/following{/other_user}","gists_url":"https://api.github.com/users/gforge/gists{/gist_id}","starred_url":"https://api.github.com/users/gforge/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gforge/subscriptions","organizations_url":"https://api.github.com/users/gforge/orgs","repos_url":"https://api.github.com/users/gforge/repos","events_url":"https://api.github.com/users/gforge/events{/privacy}","received_events_url":"https://api.github.com/users/gforge/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":{"login":"AlexMili","id":3868307,"avatar_url":"https://avatars.githubusercontent.com/u/3868307?v=3","gravatar_id":"","url":"https://api.github.com/users/AlexMili","html_url":"https://github.com/AlexMili","followers_url":"https://api.github.com/users/AlexMili/followers","following_url":"https://api.github.com/users/AlexMili/following{/other_user}","gists_url":"https://api.github.com/users/AlexMili/gists{/gist_id}","starred_url":"https://api.github.com/users/AlexMili/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AlexMili/subscriptions","organizations_url":"https://api.github.com/users/AlexMili/orgs","repos_url":"https://api.github.com/users/AlexMili/repos","events_url":"https://api.github.com/users/AlexMili/events{/privacy}","received_events_url":"https://api.github.com/users/AlexMili/received_events","type":"User","site_admin":false},"milestone":null,"comments":4,"created_at":"2016-04-10T10:03:04Z","updated_at":"2016-05-22T13:58:13Z","closed_at":"2016-05-22T13:58:13Z","body":"You have currently used a system similar to [LDoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) but it doesn't entirely follow those rules. It may be worth changing the syntax to something that provides an automated documentation for at least the API. Coming from R I'm used to using [roxygen2](https://cran.r-project.org/web/packages/roxygen2/vignettes/roxygen2.html) that handles this entire problem in an excellent fashion. \r\n\r\nI also like the `dok.unpack` functionality and it basically takes care of all the documentation (except the return value). Ideally I would like to combine the `dok.unpack` with [LDoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) but I guess that would require adding an LDoc extension. I'm pretty sure that there is some way of getting the [torch/dok](https://github.com/torch/dok) to generate documentation but for a documentation package it is surprisingly poorly documented."}}
{"actor":{"display_login":"AlexMili"}}