Opened 8 years ago

Closed 8 years ago

#13852 closed defect (fixed)

fix "SEVERE" warning during docbuilding for matrix/benchmark.py

Reported by: jhpalmieri Owned by: mvngu
Priority: critical Milestone: sage-5.6
Component: documentation Keywords:
Cc: Merged in: sage-5.6.beta1
Authors: John Palmieri Reviewers: Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by jhpalmieri)

When building the documentation, a warning appears:

SAGE_ROOT/local/lib/python2.7/site-packages/sage/matrix/benchmark.py:docstring of sage.matrix.benchmark.SetPartitionsAk:3: SEVERE: Unexpected section title.

Methods
-------

I think this is due to the line

from sage.all import *

at the top of that file. Its page in the reference manual includes (for reasons I don't understand) entries from all kinds of functions which are not present in that file, like sage.matrix.benchmark.SetPartitionsAk(k), sage.matrix.benchmark.allocatemem, and others. Changing the import statement to be more precise seems to fix things.

Attachments (1)

trac_13852-benchmark.patch (1.7 KB) - added by jhpalmieri 8 years ago.

Download all attachments as: .zip

Change History (7)

Changed 8 years ago by jhpalmieri

comment:1 Changed 8 years ago by jhpalmieri

  • Description modified (diff)

comment:2 Changed 8 years ago by kcrisman

  • Component changed from PLEASE CHANGE to documentation
  • Owner changed from tbd to mvngu

comment:3 Changed 8 years ago by jdemeyer

  • Status changed from new to needs_review

comment:4 Changed 8 years ago by jdemeyer

  • Reviewers set to Jeroen Demeyer
  • Status changed from needs_review to positive_review

comment:5 Changed 8 years ago by jdemeyer

  • Priority changed from blocker to critical

comment:6 Changed 8 years ago by jdemeyer

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