[IPython-dev] [IPython-user] On Eggs and the striping of docs & examples

Fernando Perez Fernando.Perez at colorado.edu
Wed Jan 25 02:06:02 CST 2006


Ville Vainio wrote:
> On 1/25/06, Fernando Perez <Fernando.Perez at colorado.edu> wrote:
> 
> 
>>ground, even if it's just plain text and slightly long.  They can always read
>>it a few times, the first just getting the basics, and later coming back to
>>read details.  That text should mostly describe how to find more info (use of
> 
> 
> I wasn't really thinking of a tutorial / getting started guide, but a
> quick reference, like those printable emacs/vi keybinding charts.
> 
> With oneliners like:
> 
> 'cd', '%cd': Call magic function cd
> '%cd?': Get help for magic function cd
> 
> It's an easy thing to get going, and worth a shot for offline users,
> even advanced ones (certainly better than externally launched
> documentation, people are lazy).

Actually, if we were more systematic in making sure that all magics had a true 
one-line description (I think most do, but not all), the quickref could 
summarize these.  Kind of what 'magic' does, but just printing the first line. 
  That would be useful.


> I think importing the 'usage' module only when needed would be doable
> as well, to conserve a bit of memory (probably only cosmetic effect
> though).

That one is _definitely_ cosmetic :)

Cheers,

f




More information about the IPython-dev mailing list