> I'd want that the links to the tutorials have enough descriptive text to
> that readers can decide which link to click.
> With that in place, I do not see much room for confusion.
>
What do you think the two links should say?
There is a lot of overlap between the two docs (intro, basics, and many
topics).
> There's a different reason to merge: More tutorials means more official
> text to review for validity with every SymPy release.
> Can this work be kept to a minimum?
> Main point would be to make sure that all examples still work. I'd
> almost expect that SymPy's release procedure has some doctest equivalent
> for the tutorial;
That's a very cool idea. Apparently, we can already run .rst files (and
.md files)
through doctest and the code blocks within them will be processed. For
example:
$ cat tut.rst
=======
WELCOME
=======
The ``string`` module comes with some useful constants.
For example::
>>> import string
>>> string.ascii_letters
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
Which can then be tested using:
$ python -m doctest -v tut.rst
Trying:
import string
Expecting nothing
ok
Trying:
string.ascii_letters
Expecting:
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
ok
1 items passed all tests:
2 tests in tut.rst
2 tests in 1 items.
2 passed and 0 failed.
Test passed.
I also tried running the files in doc/src/tutorial through doctest
and most of them pass (except for minor formatting differences,
like line breaks and latex output using unicode symbols).
Maybe we need a doctest-variant that is tolerant towards
minor formatting diffs and the whole "testing the docs" could
be automated...
Ivan
Ivan
--
You received this message because you are subscribed to the Google Groups
"sympy" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sympy.
To view this discussion on the web visit
https://groups.google.com/d/msgid/sympy/5d9dfca8-b145-4310-9409-0dad866fe787%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
