{"action":"created","issue":{"url":"https://api.github.com/repos/tlycken/Interpolations.jl/issues/46","labels_url":"https://api.github.com/repos/tlycken/Interpolations.jl/issues/46/labels{/name}","comments_url":"https://api.github.com/repos/tlycken/Interpolations.jl/issues/46/comments","events_url":"https://api.github.com/repos/tlycken/Interpolations.jl/issues/46/events","html_url":"https://github.com/tlycken/Interpolations.jl/issues/46","id":95823204,"number":46,"title":"Documentation overhaul","user":{"login":"tlycken","id":1550920,"avatar_url":"https://avatars.githubusercontent.com/u/1550920?v=3","gravatar_id":"","url":"https://api.github.com/users/tlycken","html_url":"https://github.com/tlycken","followers_url":"https://api.github.com/users/tlycken/followers","following_url":"https://api.github.com/users/tlycken/following{/other_user}","gists_url":"https://api.github.com/users/tlycken/gists{/gist_id}","starred_url":"https://api.github.com/users/tlycken/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tlycken/subscriptions","organizations_url":"https://api.github.com/users/tlycken/orgs","repos_url":"https://api.github.com/users/tlycken/repos","events_url":"https://api.github.com/users/tlycken/events{/privacy}","received_events_url":"https://api.github.com/users/tlycken/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/tlycken/Interpolations.jl/labels/documentation","name":"documentation","color":"5319e7"},{"url":"https://api.github.com/repos/tlycken/Interpolations.jl/labels/intro-issue","name":"intro-issue","color":"159818"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":4,"created_at":"2015-07-18T13:00:15Z","updated_at":"2016-01-26T07:04:47Z","closed_at":null,"body":"This is to discuss changes to, and completion of, documentation for this package. Major questions are:\r\n\r\n* How do we want to organize the documentation? Formats, locations etc...\r\n* What should be documented (more than just by writing clear code)? Devdocs? Implementation details?\r\n* On what level of detail do we want to document things?\r\n\r\nSome discussion started in #45 already, where the following points [were raised](https://github.com/tlycken/Interpolations.jl/pull/45#issuecomment-122535090):\r\n\r\n> In a sense the README could be a summary of what's available, now that\r\n>\r\n>     julia> using Interpolations\r\n>     julia> ?Interpolations\r\n>\r\n> dumps the README contents. So I've begun to think that it might be good to keep the README as an \"API reminder\" for people who already understand the package, and the IJulia notebook as an introduction to the package.\r\n\r\nI agree that it's probably a good idea to make the readme minimalistic. I'd also like to start documenting most other things in a `help>`-compatible way, so we might want to move off from the IJulia notebooks alltogether. And I feel like I have to strip down the LaTeX stuff to something with minimal dependencies, so anyone can at least compile it, but it is a very handy way to document the mathematical background of any methods we implement..."},"comment":{"url":"https://api.github.com/repos/tlycken/Interpolations.jl/issues/comments/174864091","html_url":"https://github.com/tlycken/Interpolations.jl/issues/46#issuecomment-174864091","issue_url":"https://api.github.com/repos/tlycken/Interpolations.jl/issues/46","id":174864091,"user":{"login":"tlycken","id":1550920,"avatar_url":"https://avatars.githubusercontent.com/u/1550920?v=3","gravatar_id":"","url":"https://api.github.com/users/tlycken","html_url":"https://github.com/tlycken","followers_url":"https://api.github.com/users/tlycken/followers","following_url":"https://api.github.com/users/tlycken/following{/other_user}","gists_url":"https://api.github.com/users/tlycken/gists{/gist_id}","starred_url":"https://api.github.com/users/tlycken/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tlycken/subscriptions","organizations_url":"https://api.github.com/users/tlycken/orgs","repos_url":"https://api.github.com/users/tlycken/repos","events_url":"https://api.github.com/users/tlycken/events{/privacy}","received_events_url":"https://api.github.com/users/tlycken/received_events","type":"User","site_admin":false},"created_at":"2016-01-26T07:04:47Z","updated_at":"2016-01-26T07:04:47Z","body":"That would be most appreciated! "}}