Opened 11 years ago

Closed 9 years ago

#8046 closed defect (fixed)

Add matrix/matrix_double_dense.py to documentation

Reported by: rbeezer Owned by: mvngu
Priority: major Milestone: sage-5.0
Component: documentation Keywords: beginner sd35.5
Cc: Merged in: sage-5.0.beta1
Authors: Kenneth Smith, John Palmieri Reviewers: John Palmieri, Karl-Dieter Crisman
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by jhpalmieri)

The source file matrix/matrix_double_dense.py is not included in the documentation. It appears that it should be, since it has functions that are of interest to users. Patch simply adds it to the right place in the documentation tree.

The file itself needs some love. After #4756 goes in, the following four functions should be in good shape. The remainder needs work.

left_eigenvectors()
right_eigenvectors()
eigenspaces_left()
eigenspaces_right()

Apply trac_8046_matrix_double_dense.patch and trac_8046-ref.patch.

Attachments (3)

trac_8046_matrix_double_doc_add.patch (593 bytes) - added by rbeezer 11 years ago.
trac_8046_matrix_double_dense.patch (13.8 KB) - added by ksmith 9 years ago.
trac_8046-ref.patch (3.9 KB) - added by jhpalmieri 9 years ago.

Download all attachments as: .zip

Change History (14)

Changed 11 years ago by rbeezer

comment:1 follow-up: Changed 10 years ago by jason

  • Status changed from new to needs_work

I get some errors on 4.6.1 when building the docs:

docstring of sage.matrix.matrix_double_dense.Matrix_double_dense.condition:11: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
docstring of sage.matrix.matrix_double_dense:7: (ERROR/3) Unexpected indentation.
docstring of sage.matrix.matrix_double_dense.Matrix_double_dense.numpy:11: (WARNING/2) Block quote ends without a blank line; unexpected unindent.
docstring of sage.matrix.matrix_double_dense:13: (ERROR/3) Unexpected indentation.
docstring of sage.matrix.matrix_double_dense:13: (ERROR/3) Unexpected indentation.
<autodoc>:0: (ERROR/3) Unexpected indentation.

comment:2 in reply to: ↑ 1 Changed 10 years ago by rbeezer

Replying to jason:

Yes, the file "needs_work". I went through it a couple days ago and cleaned up lots of little things (documentation mostly), but then went off and made a few patches with code changes. I'll get back to it very soon and insert into the other work I'm doing.

comment:3 Changed 9 years ago by kcrisman

  • Keywords beginner sd35.5 added

comment:4 Changed 9 years ago by ksmith

  • Authors set to Kenneth Smith

I made a new patch. This one includes the matrix double dense to the documentation like the last one, and it also edits the file a lot to get rid of almost all of the syntax errors. I am still getting 2 warnings however:

One is:

docstring of sage.matrix.matrix_double_dense:8: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.

I cannot, however find what the error message is talking about, even after multiple people examined it for quite a while.

The other one is:

WARNING: dvipng command 'dvipng' cannot be run (needed for math display), check the pngmath_dvipng setting

which I am told can be ignored.

So really there is just one warning that could still be fixed.

Changed 9 years ago by ksmith

comment:5 Changed 9 years ago by jhpalmieri

  • Description modified (diff)

I'm attaching a 'referee' patch to fix up some docstrings. The first change in that patch fixes the warning message about the unexpected unindent; the others just tidy some things up.

Changed 9 years ago by jhpalmieri

comment:6 Changed 9 years ago by kcrisman

  • Authors changed from Kenneth Smith to Kenneth Smith, John Palmieri
  • Status changed from needs_work to needs_review

comment:7 Changed 9 years ago by kcrisman

  • Reviewers set to John Palmieri, Karl-Dieter Crisman, Jason Grout, Jeroen Demeyer, Steven Trogdon, Leif Leonhardy, Sébastien Labbé
  • Status changed from needs_review to positive_review

Looks great! Thanks for catching this, John.

comment:8 follow-up: Changed 9 years ago by jason

If you build the documentation with "-j", it will use jsmath, and should not give the error about dvipng: sage -docbuild reference html -j

comment:9 in reply to: ↑ 8 Changed 9 years ago by kcrisman

  • Reviewers changed from John Palmieri, Karl-Dieter Crisman, Jason Grout, Jeroen Demeyer, Steven Trogdon, Leif Leonhardy, Sébastien Labbé to John Palmieri, Karl-Dieter Crisman

If you build the documentation with "-j", it will use jsmath, and should not give the error about dvipng: sage -docbuild reference html -j

Interesting. In any case, that was clearly an unrelated error.

comment:10 Changed 9 years ago by jdemeyer

  • Milestone changed from sage-4.8 to sage-5.0

comment:11 Changed 9 years ago by jdemeyer

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