inaccuracy in SR.var docstring

[mforets]

in SR.var?,

* "n" -- (optional) nonnegative integer; number of symbolic
     variables, indexed from 0 to n-1

but it should say positive, because SR.var('x', 0) fails.

(the exception message, raise ValueError("the number of variables should be a positive integer"), is indeed correct).

CC: @zimmermann6 @fchapoton

Component: symbolics

Keywords: symbolic ring

Author: Marcelo Forets

Branch/Commit: 7968cf0

Reviewer: Marc Mezzarobba

Issue created by migration from https://trac.sagemath.org/ticket/23743

[mforets]

Branch: u/mforets/23743

[mforets]

Author: Marcelo Forets

[mforets]

comment:1

i've changed the example to the assignment, x = SR.var('x', 4); x, because it's the only way that it can be used later.

---

New commits:

e26225a

#23743 : fix docstring for keyword n of SR.var

[mforets]

Commit: e26225a

[mezzarobba]

Reviewer: Marc Mezzarobba

[mezzarobba]

comment:2

Thanks!

(Since you added the assignment to x, you could even replace the example displaying x as a tuple by something like x[1] or x[0], x[3] to illustrate how the returned tuple can be used.)

[sagetrac-git]

Changed commit from e26225a to 7968cf0

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

7968cf0

#2743 : examples showing use of x[i]

[mforets]

comment:4

thanks for reviewing Marc!

yes, i like your idea, thus i've edited the example and this ticket needs review again.

[vbraun]

Changed branch from u/mforets/23743 to 7968cf0