I've posted a patch to the trac server with some documentation changes along these lines:
http://trac.sagemath.org/sage_trac/ticket/3145 John On May 7, 11:07 am, John H Palmieri <[EMAIL PROTECTED]> wrote: > The documentation for 'view' has one typo, and perhaps some other > problems. Part of it reads like this: > > INPUT: > objects -- list (or object) > title -- string > zoom -- zoom factor, passed on to xdvi > expert -- bool (True or False): mode passed onto xdvi > debug -- bool (True of False): print verbose output > sep -- string -- controls separators for math objects > tiny -- bool (default: False) use tiny font. > center -- bool (default: False) center > > First, on the line for 'debug', it should say "True or False", not > "True of False". > > Second, should it? Is there a style guide for documentation? Should > the documentation for view really explain what 'bool' means? Should > it instead say what the default values for these things are, the way > it does for tiny and center? Should it say the following instead: > > INPUT: > objects -- list (or object) > title -- string (default: 'SAGE'): title for the xdvi window > zoom -- integer (default: 4): zoom factor, passed on to xdvi > expert -- bool (default: True): mode passed on to xdvi > debug -- bool (default: False): print verbose output > sep -- string (default '$$ $$'): controls separators for math > objects > tiny -- bool (default: False) use tiny font. > center -- bool (default: False) center > > Finally, the documentation isn't completely clear. In this revision, I > say that 'title' is the title for the xdvi window; is that actually > right? I'm just guessing (since 'view' doesn't actually work for me > -- I'll post separately about that). Also, what does 'sep' do? > > (For what it's worth, I've seen LaTeX gurus complain that one should > not use $$ $$ for displaying math; \[ \] is better. Should the > default value of 'sep' be changed?) > > John --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
