Thanks Minh,

for your suggestions. In fact, I wouldn't have expected that simply
typing "sage -docbuild" gives a nice help.

In fact, sage is not quite consistent here. "sage -b" does actually do
something. Would be nice if there were a system so that, for example,
"sage -h -some-option" would give a longer explanation of how to use
that option. In some sense it should be like "hg help", "hg help update".

Just a suggestion...

First, of course, sage should have long options only with double dash.
The usual convention would be --docbuild, no?


>> In fact, to me it's a bit unclear what I can actually put as
>> "lang" and <document>.
> 
> A better help message would also include how to get help on all 
> options for docbuild.

Yes, good suggestion.

>> BTW, is there some reason why the -advanced output doesn't use an 
>> 80 character line length. It's really hard to read if the lines 
>> wrap.

> That is an issue that a lot of files in the Sage library (and 
> elsewhere) don't attend to. I personally like to have no more than 80
> characters per line. But in some cases, I would make an exception. 
> But that's my personal preference.

Then maybe all developer should re-read what

http://www.sagemath.org/doc/developer/conventions.html#python-coding-conventions

says quite at the beginning...

http://www.python.org/dev/peps/pep-0008/
==================================
Maximum Line Length

    Limit all lines to a maximum of 79 characters.
==================================

Maybe patches on trac should not be approved, if the guidelines are not
followed. ;-)
(Oh, yes, I know that sage-sage is a bash-script.)

Ralf

-- 
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel+unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org

Reply via email to