Opened 12 years ago

Closed 8 years ago

#5761 closed defect (fixed)

Bring doctests of sage/misc/latex.py to 100%

Reported by: rbeezer Owned by: rbeezer
Priority: major Milestone: sage-5.7
Component: doctest coverage Keywords: documentation, coverage, latex
Cc: Merged in: sage-5.7.beta4
Authors: Travis Scrimshaw Reviewers: André Apitzsch
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Attachments (1)

trac_5761-latex_docstrings-ts.patch (34.5 KB) - added by tscrim 8 years ago.
Fixed trailing whitespace and matched ticket number

Download all attachments as: .zip

Change History (11)

comment:1 Changed 12 years ago by rbeezer

  • Owner changed from mabshoff to rbeezer

I'm partway through this, but still need to do much more, and will be away from it for a few days.

comment:2 Changed 12 years ago by mabshoff

  • Milestone changed from sage-3.4.1 to sage-3.4.2

Bouncing to 3.4.2.

Cheers,

Michael

comment:3 Changed 8 years ago by tscrim

  • Authors set to Travis Scrimshaw
  • Keywords documentation coverage latex added
  • Report Upstream set to N/A
  • Status changed from new to needs_review

I've gone through an brought the documentation for latex.py to full coverage and up to current standards. I've also removed the ~2 year old deprecated method pdflatex().

comment:4 Changed 8 years ago by aapitzsch

  • Reviewers set to André Apitzsch
  • Status changed from needs_review to needs_work

There are some True, False and None not surrounded by ``.

After

"\\ZZ[x]

in

EXAMPLES::

    # sage: latex.eval("\\ZZ[x], locals(), filename="test") # This would generate a file named "test.png"
    # ''
    # sage: latex.eval("\\ZZ[x], locals(), filename="/path/to/test") # This would generate a file named "/path/to/test.png"
    # ''

a " is missing, otherwise the command will fail. You can use # not tested at the end of the line instead of commenting out the examples.

Everything else looks good to me.

comment:5 Changed 8 years ago by tscrim

  • Status changed from needs_work to needs_review

I believe I caught them all; let me know where if I missed any others.

Thanks for the review,
Travis

comment:6 Changed 8 years ago by aapitzsch

Could you add an additional patch to fix the trac reference in repr_lincomb():

Verify that a certain corner case works (see trac 5707 and 5766)::

and in latex_varify():

if "is_fname" flag is True or False.

comment:7 Changed 8 years ago by tscrim

  • Description modified (diff)

Fixed. I've also made the patchbot offending test optional.


For patchbot:

Apply only: trac_5791-latex_docstrings-ts.patch

comment:8 Changed 8 years ago by aapitzsch

  • Status changed from needs_review to positive_review

You added one trailing whitespace after "An error"

sage: latex.eval("\ThisIsAnInvalidCommand", {}) # optional - requires 'convert'
An error

But I think it's no problem. So I'm giving this a positive review. Let's hope the release manager does not complain about the wrong number in the filename. ;)

Changed 8 years ago by tscrim

Fixed trailing whitespace and matched ticket number

comment:9 Changed 8 years ago by tscrim

  • Description modified (diff)

Fixed. Thank you.

For patchbot:

Apply only: trac_5761-latex_docstrings-ts.patch

comment:10 Changed 8 years ago by jdemeyer

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