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.Wed, 08 Apr 2015 12:28:45 -0500how to report typos in the documentation?http://ask.sagemath.org/question/26467/how-to-report-typos-in-the-documentation/Now and then I spot typos in the documentation. What is the appropriate way to report such typos?
E.g. in "Linear Codes -- Sage Reference Manual v6.2: Coding Theory" in the function
"redunadancy_matrix(C)"
instead of (in TeX)
$kimes(n-k)$ matrix
it should be
$k\times(n-k)$ matrix
best ThomasWed, 08 Apr 2015 11:48:29 -0500http://ask.sagemath.org/question/26467/how-to-report-typos-in-the-documentation/Answer by kcrisman for <p>Now and then I spot typos in the documentation. What is the appropriate way to report such typos?
E.g. in "Linear Codes -- Sage Reference Manual v6.2: Coding Theory" in the function
"redunadancy_matrix(C)"
instead of (in TeX)
$kimes(n-k)$ matrix
it should be
$k\times(n-k)$ matrix
best Thomas</p>
http://ask.sagemath.org/question/26467/how-to-report-typos-in-the-documentation/?answer=26469#post-id-26469The canonical place is the [Sage Trac](http://trac.sagemath.org/), but you need an account for that. If you have a Github account you could create a pull request or something at the [Github page](https://github.com/sagemath/sage), and the [sage-support Google group](https://groups.google.com/forum/#!forum/sage-support) will get some attention as well.
In this case, I would *first* check that the typo is still extant. In this case, it [appears to be](http://www.sagemath.org/doc/reference/coding/sage/coding/linear_code.html), so I've reported a fix [here](http://trac.sagemath.org/ticket/18146) - a one-character change ought to do it, though there are other issues in the file as well.Wed, 08 Apr 2015 12:21:31 -0500http://ask.sagemath.org/question/26467/how-to-report-typos-in-the-documentation/?answer=26469#post-id-26469Comment by kcrisman for <p>The canonical place is the <a href="http://trac.sagemath.org/">Sage Trac</a>, but you need an account for that. If you have a Github account you could create a pull request or something at the <a href="https://github.com/sagemath/sage">Github page</a>, and the <a href="https://groups.google.com/forum/#!forum/sage-support">sage-support Google group</a> will get some attention as well.</p>
<p>In this case, I would <em>first</em> check that the typo is still extant. In this case, it <a href="http://www.sagemath.org/doc/reference/coding/sage/coding/linear_code.html">appears to be</a>, so I've reported a fix <a href="http://trac.sagemath.org/ticket/18146">here</a> - a one-character change ought to do it, though there are other issues in the file as well.</p>
http://ask.sagemath.org/question/26467/how-to-report-typos-in-the-documentation/?comment=26471#post-id-26471See also http://ask.sagemath.org/question/8830/what-is-the-best-way-to-report-small-glitches-in-the-docs/Wed, 08 Apr 2015 12:28:45 -0500http://ask.sagemath.org/question/26467/how-to-report-typos-in-the-documentation/?comment=26471#post-id-26471