#11698: Fix trivial typo in Sage devel guide
------------------------------+---------------------------------------------
Reporter: kcrisman | Owner: mvngu
Type: defect | Status: needs_review
Priority: trivial | Milestone: sage-4.7.2
Component: documentation | Keywords:
Work_issues: | Upstream: N/A
Reviewer: Leif Leonhardy | Author: Karl-Dieter Crisman
Merged: | Dependencies:
------------------------------+---------------------------------------------
Comment(by kcrisman):
Replying to [comment:5 leif]:
> Hmmm, so far only looked at the patch:
>
> I would consistently use double dashs for all long options, i.e.
`--docbuild`, since many people consider long options with a single dash
deprecated, so we IMHO shouldn't encourage people to use the "old" form.
See, now you are asking me to change things that were not broken,
presumably. I just fixed the specific typos involved with help.
> The quoted strings {{{"html"}}}, {{{"pdf"}}} etc. should IMHO be typeset
as code, i.e. {{{``html``}}}, {{{``pdf``}}} and the like.
I thought about that, but again, it was a bigger change than I wanted to
make.
> I'd say ''"for the options to `sage --docbuild`"'' rather than ''"for
the `sage -docbuild` script"''.
That seems ok.
> [I'm aware or, more precisely, pretty sure that there are many further
instances of the above in the Developer's Guide; I'd be happy with just
changing them in the currently affected file, `sage_manuals.rst`.]
I would ask for a different ticket to fix all those things consistently.
I had time to make this patch, but not that bigger patch you are talking
about (I'd rather review someone else's patches on other tickets).
> IIRC a Russian translation is ready to get merged, and a not-that-ready
German one rottens somewhere... ;-)
Hmm, I didn't know that.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11698#comment:6>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
