#8464: add FAQ to standard documentation
---------------------------------------------------------------------+------
Reporter: mvngu |
Owner: mvngu
Type: enhancement |
Status: needs_work
Priority: major |
Milestone: sage-4.4.2
Component: documentation |
Keywords: FAQ
Author: Minh Van Nguyen |
Upstream: N/A
Reviewer: John Palmieri, Mark Jordan, Jose Guzman, Pablo Angulo |
Merged:
Work_issues: |
---------------------------------------------------------------------+------
Changes (by mvngu):
* status: positive_review => needs_work
Old description:
> Add the [http://wiki.sagemath.org/faq FAQ] on the Sage wiki to the Sage
> [http://www.sagemath.org/doc/ standard documentation]. The original
> proposal can be found on [http://groups.google.com/group/sage-
> devel/browse_thread/thread/95afb345e872f9af sage-devel] and
> [http://groups.google.com/group/sage-combinat-devel/msg/662eb0246c7bf9fc
> sage-combinat-devel].
> [[BR]][[BR]]
> '''Notes:''' The current ticket needs to be coordinated with #8470.
> [[BR]][[BR]]
> '''Prerequisites:''' #8480
> [[BR]][[BR]]
> '''Apply in this order:'''
>
> 1.
> [http://trac.sagemath.org/sage_trac/attachment/ticket/8464/trac_8464-faq.patch
> trac_8464-faq.patch]
> 1.
> [http://trac.sagemath.org/sage_trac/attachment/ticket/8464/trac_8464-ref.patch
> trac_8464-ref.patch]
> 1. [http://trac.sagemath.org/sage_trac/attachment/ticket/8464/trac_8464
> -faq-general.2.patch trac_8464-faq-general.2.patch]
New description:
Add the [http://wiki.sagemath.org/faq FAQ] on the Sage wiki to the Sage
[http://www.sagemath.org/doc/ standard documentation]. The original
proposal can be found on [http://groups.google.com/group/sage-
devel/browse_thread/thread/95afb345e872f9af sage-devel] and
[http://groups.google.com/group/sage-combinat-devel/msg/662eb0246c7bf9fc
sage-combinat-devel].
[[BR]][[BR]]
'''Notes:''' The current ticket needs to be coordinated with #8470.
[[BR]][[BR]]
'''Prerequisites:''' #8480
[[BR]][[BR]]
'''Apply in this order:'''
1.
[http://trac.sagemath.org/sage_trac/attachment/ticket/8464/trac_8464-faq.patch
trac_8464-faq.patch]
1.
[http://trac.sagemath.org/sage_trac/attachment/ticket/8464/trac_8464-ref.patch
trac_8464-ref.patch]
1. [http://trac.sagemath.org/sage_trac/attachment/ticket/8464/trac_8464
-faq-general.2.patch trac_8464-faq-general.2.patch]
1.
[http://trac.sagemath.org/sage_trac/attachment/ticket/8464/trac_8464-doctest.patch
trac_8464-doctest.patch]
--
Comment:
After applying all three patches to Sage 4.4.2.rc0, running doctests
resulted in the following failure:
{{{
[mv...@sage sage-4.4.2.rc0]$ ./sage -t -long devel/sage-main/doc/en/faq
/faq-usage.rstsage -t -long "devel/sage-main/doc/en/faq/faq-usage.rst"
**********************************************************************
File "/dev/shm/mvngu/release/sage-4.4.2.rc0/devel/sage-main/doc/en/faq
/faq-usage.rst", line 134:
sage: load("simple.py")
Exception raised:
Traceback (most recent call last):
File
"/dev/shm/mvngu/release/sage-4.4.2.rc0/local/bin/ncadoctest.py", line
1231, in run_one_test
self.run_one_example(test, example, filename, compileflags)
File
"/dev/shm/mvngu/release/sage-4.4.2.rc0/local/bin/sagedoctest.py", line 38,
in run_one_example
OrigDocTestRunner.run_one_example(self, test, example, filename,
compileflags)
File
"/dev/shm/mvngu/release/sage-4.4.2.rc0/local/bin/ncadoctest.py", line
1172, in run_one_example
compileflags, 1) in test.globs
File "<doctest __main__.example_0[2]>", line 1, in <module>
load("simple.py")###line 134:
sage: load("simple.py")
File "sage_object.pyx", line 698, in sage.structure.sage_object.load
(sage/structure/sage_object.c:7304)
File "/dev/shm/mvngu/release/sage-4.4.2.rc0/local/lib/python/site-
packages/sage/misc/preparser.py", line 1501, in load
execfile(filename, globals)
IOError: [Errno 2] No such file or directory: 'simple.py'
**********************************************************************
File "/dev/shm/mvngu/release/sage-4.4.2.rc0/devel/sage-main/doc/en/faq
/faq-usage.rst", line 138:
sage: attach("simple.py")
Exception raised:
Traceback (most recent call last):
File
"/dev/shm/mvngu/release/sage-4.4.2.rc0/local/bin/ncadoctest.py", line
1231, in run_one_test
self.run_one_example(test, example, filename, compileflags)
File
"/dev/shm/mvngu/release/sage-4.4.2.rc0/local/bin/sagedoctest.py", line 38,
in run_one_example
OrigDocTestRunner.run_one_example(self, test, example, filename,
compileflags)
File
"/dev/shm/mvngu/release/sage-4.4.2.rc0/local/bin/ncadoctest.py", line
1172, in run_one_example
compileflags, 1) in test.globs
File "<doctest __main__.example_1[2]>", line 1, in <module>
attach("simple.py")###line 138:
sage: attach("simple.py")
File "session.pyx", line 425, in sage.misc.session.attach
(sage/misc/session.c:2017)
File "/dev/shm/mvngu/release/sage-4.4.2.rc0/local/lib/python/site-
packages/sage/misc/preparser.py", line 1501, in load
execfile(filename, globals)
IOError: [Errno 2] No such file or directory: 'simple.py'
}}}
I have attached a patch to resolve this. Anyone care for another trivial
review?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8464#comment:19>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
