ASKSAGE: Sage Q&A Forum - Individual question feedhttp://ask.sagemath.org/questions/Q&A Forum for SageenCopyright Sage, 2010. Some rights reserved under creative commons license.Tue, 27 Mar 2012 15:42:02 -0500What is the best way to report small glitches in the docs?http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/For example on page
[number theory](http://www.sagemath.org/doc/constructions/number_theory.html)
the section 'Divisors' says:
<pre>
Sage uses divisors(n) for the number [...] of divisors of n ...
</pre>
and adds the example
<pre>
divisors(28)
[1, 2, 4, 7, 14, 28]
</pre>Tue, 27 Mar 2012 08:24:43 -0500http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/Answer by kcrisman for <p>For example on page
<a href="http://www.sagemath.org/doc/constructions/number_theory.html">number theory</a>
the section 'Divisors' says:</p>
<pre>Sage uses divisors(n) for the number [...] of divisors of n ...
</pre>
<p>and adds the example</p>
<pre>divisors(28)
[1, 2, 4, 7, 14, 28]
</pre>
http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/?answer=13396#post-id-13396Get a [Trac account](http://trac.sagemath.org/sage_trac/), check to make sure there isn't already one open for this, and open a new ticket! Any issue, no matter how small, deserves a ticket - certainly any errors.Tue, 27 Mar 2012 08:46:29 -0500http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/?answer=13396#post-id-13396Comment by kcrisman for <p>Get a <a href="http://trac.sagemath.org/sage_trac/">Trac account</a>, check to make sure there isn't already one open for this, and open a new ticket! Any issue, no matter how small, deserves a ticket - certainly any errors.</p>
http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/?comment=20035#post-id-20035Yes, there is - it's called asking someone else to do so :) One way or another someone must do so. Naturally, reporting it on sage-support or here might lead to that as well. This way we cleverly get people to become Sage contributors :)Tue, 27 Mar 2012 15:40:53 -0500http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/?comment=20035#post-id-20035Comment by petropolis for <p>Get a <a href="http://trac.sagemath.org/sage_trac/">Trac account</a>, check to make sure there isn't already one open for this, and open a new ticket! Any issue, no matter how small, deserves a ticket - certainly any errors.</p>
http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/?comment=20038#post-id-20038Well, I certainly hoped that there is a less bureaucratic (and time consuming) way for small and obvious errors in the documentation.Tue, 27 Mar 2012 10:04:21 -0500http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/?comment=20038#post-id-20038Comment by kcrisman for <p>Get a <a href="http://trac.sagemath.org/sage_trac/">Trac account</a>, check to make sure there isn't already one open for this, and open a new ticket! Any issue, no matter how small, deserves a ticket - certainly any errors.</p>
http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/?comment=20034#post-id-20034As to why Trac tickets at all for "trivial" things: This way we have a full accounting of such things. Any change in Sage currently *must* have a ticket associated with it. The idea is that everything in Sage is open to full public discussion; that does add a layer of bureaucracy, but has saved us from countless dumb introductions of bugs. In the doc case, it usually becomes an opportunity for people to do some additional cleaning up of whitespace or other typos at the same time.Tue, 27 Mar 2012 15:42:02 -0500http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/?comment=20034#post-id-20034