#8511: docstring fix for "unexpected indentation"
-------------------------------+--------------------------------------------
Reporter: jhpalmieri | Owner: jhpalmieri
Type: defect | Status: needs_review
Priority: critical | Milestone: sage-4.3.4
Component: documentation | Keywords:
Author: John Palmieri | Upstream: N/A
Reviewer: Minh Van Nguyen | Merged:
Work_issues: |
-------------------------------+--------------------------------------------
Changes (by mvngu):
* reviewer: => Minh Van Nguyen
Comment:
The patch
[http://trac.sagemath.org/sage_trac/attachment/ticket/8511/trac_8511
-unexpected-indentation.patch trac_8511-unexpected-indentation.patch]
solves the three warnings reported at #8492. However, note that the
formatting in the following snippet won't properly render in the HTML
version as one would expect TESTS and EXAMPLES block to render:
{{{
#!diff
diff -r 29c870e0a9e4 -r 8851bfe046d1 sage/symbolic/expression.pyx
--- a/sage/symbolic/expression.pyx Mon Mar 08 20:51:26 2010 -0800
+++ b/sage/symbolic/expression.pyx Fri Mar 12 15:12:47 2010 -0800
@@ -3151,7 +3151,8 @@
sage: t.subs({a:b, b:c})
(x + y)^3 + b^2 + c^2
- TESTS:
+ TESTS::
+
# no arguments return the same expression
sage: t.subs()
(x + y)^3 + a^2 + b^2
}}}
This is due to the comment
{{{
# no arguments return the same expression
}}}
To get this TESTS block to render with colours as one would expect of a
TESTS block, prefix that comment with "sage: ". The reviewer patch
[http://trac.sagemath.org/sage_trac/attachment/ticket/8511/trac_8511-reviewer.patch
trac_8511-reviewer.patch] takes care of that. So only my patch needs
review by anyone but me. If it gets a positive review, the whole ticket is
good to go into Sage 4.3.4.rc0.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8511#comment:4>
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.
