{"action":"opened","issue":{"url":"https://api.github.com/repos/jupyter/jupyter/issues/24","labels_url":"https://api.github.com/repos/jupyter/jupyter/issues/24/labels{/name}","comments_url":"https://api.github.com/repos/jupyter/jupyter/issues/24/comments","events_url":"https://api.github.com/repos/jupyter/jupyter/issues/24/events","html_url":"https://github.com/jupyter/jupyter/issues/24","id":102622058,"number":24,"title":"Formatted docs for magic functions","user":{"login":"lmmx","id":2979452,"avatar_url":"https://avatars.githubusercontent.com/u/2979452?v=3","gravatar_id":"","url":"https://api.github.com/users/lmmx","html_url":"https://github.com/lmmx","followers_url":"https://api.github.com/users/lmmx/followers","following_url":"https://api.github.com/users/lmmx/following{/other_user}","gists_url":"https://api.github.com/users/lmmx/gists{/gist_id}","starred_url":"https://api.github.com/users/lmmx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lmmx/subscriptions","organizations_url":"https://api.github.com/users/lmmx/orgs","repos_url":"https://api.github.com/users/lmmx/repos","events_url":"https://api.github.com/users/lmmx/events{/privacy}","received_events_url":"https://api.github.com/users/lmmx/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2015-08-23T13:53:00Z","updated_at":"2015-08-23T13:53:00Z","closed_at":null,"body":"I was looking for documentation for the 'magic' functions online, but the [top hit](https://ipython.org/ipython-doc/dev/interactive/tutorial.html) on Google is a tutorial which briefly mentions some of them, and the next hit (which admittedly I only found now embarrassingly) looks right but is missing some - `%autoindent`, `%cat` and `%clear` for example aren't there, so it's hard to tell how old a version they are from (which probably explains why I didn't find them).\r\n\r\nI did the `%magic` command to get the plaintext docs, and searched this to try and find any formatted copy online but there wasn't, so I went ahead and turned them into markdown.\r\n\r\ne.g. [searching the documentation for the `%cat` command](https://www.google.co.uk/search?q=\"Callable+object+storing+the+details+of+one+alias.\"+\"Instances+are+registered+as+magic+functions+to+allow+use+of+aliases.\") shows the developer docs, but finds nothing in a readable format, nor anything 'all in one place'.\r\n\r\nI get the feeling I may have wasted my time turning the 'man pages' produced by the `%magic` command [into a markdown version](https://github.com/lmmx/devnotes/wiki/IPython-'magic'-function-documentation), as it looks like even though [that IPython list](https://ipython.org/ipython-doc/dev/interactive/magics.html) is outdated, it's processed the indenting in some way to properly format code blocks and regular `<pre>` elements within a `<dl>` definitions list — so I don't know if mine will actually be any use to you... :sweat_smile: was handy for me to read anyway\r\n\r\n( Also this may relate to #20 for a subcommand to open formatted docs in a browser )"}}