Opened 12 years ago

Closed 12 years ago

#8511 closed defect (fixed)

docstring fix for "unexpected indentation"

Reported by: jhpalmieri Owned by: jhpalmieri
Priority: critical Milestone: sage-4.3.4
Component: documentation Keywords:
Cc: Merged in: sage-4.3.4.rc0
Authors: John Palmieri Reviewers: Minh Van Nguyen
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by jhpalmieri)

When building the reference manual for 4.3.4.alpha1, I get several messages of the form

<autodoc>:0: (ERROR/3) Unexpected indentation.

The attached patch fixes these.

Attachments (3)

trac_8511-subs.patch (679 bytes) - added by jhpalmieri 12 years ago.
trac_8511-unexpected-indentation.patch (1.6 KB) - added by jhpalmieri 12 years ago.
apply only this patch
trac_8511-reviewer.patch (598 bytes) - added by mvngu 12 years ago.
reviewer patch; apply on top of previous

Download all attachments as: .zip

Change History (9)

Changed 12 years ago by jhpalmieri

comment:1 Changed 12 years ago by jhpalmieri

  • Status changed from new to needs_review

comment:2 Changed 12 years ago by jhpalmieri

  • Component changed from symbolics to documentation
  • Description modified (diff)
  • Summary changed from docstring fix for symbolic expressions to docstring fix for "unexpected indentation"

Changed 12 years ago by jhpalmieri

apply only this patch

Changed 12 years ago by mvngu

reviewer patch; apply on top of previous

comment:3 Changed 12 years ago by jhpalmieri

  • Owner changed from burcin to jhpalmieri
  • Priority changed from minor to critical

With this patch, plus the ones at #8457 and #8492, the reference manual builds with no warnings.

comment:4 Changed 12 years ago by mvngu

  • Reviewers set to Minh Van Nguyen

The 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:

  • sage/symbolic/expression.pyx

    diff -r 29c870e0a9e4 -r 8851bfe046d1 sage/symbolic/expression.pyx
    a b  
    31513151            sage: t.subs({a:b, b:c})
    31523152            (x + y)^3 + b^2 + c^2
    31533153
    3154         TESTS:
     3154        TESTS::
     3155
    31553156            # no arguments return the same expression
    31563157            sage: t.subs()
    31573158            (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 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.

comment:5 Changed 12 years ago by jhpalmieri

  • Status changed from needs_review to positive_review

Looks good to me. The TESTS block now looks right, and doctests pass.

comment:6 Changed 12 years ago by mvngu

  • Merged in set to sage-4.3.4.rc0
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.