Ask Your Question

What is the best way to report small glitches in the docs?

asked 2012-03-27 15:24:43 +0200

petropolis gravatar image

For example on page number theory the section 'Divisors' says:

Sage uses divisors(n) for the number [...] of divisors of n ...

and adds the example

[1, 2, 4, 7, 14, 28]
edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2012-03-27 15:46:29 +0200

kcrisman gravatar image

Get a Trac account, 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.

edit flag offensive delete link more



Well, I certainly hoped that there is a less bureaucratic (and time consuming) way for small and obvious errors in the documentation.

petropolis gravatar imagepetropolis ( 2012-03-27 17:04:21 +0200 )edit

Yes, 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 :)

kcrisman gravatar imagekcrisman ( 2012-03-27 22:40:53 +0200 )edit

As 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.

kcrisman gravatar imagekcrisman ( 2012-03-27 22:42:02 +0200 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools


Asked: 2012-03-27 15:24:43 +0200

Seen: 500 times

Last updated: Mar 27 '12