#18805: Add didactical implementation of tableau cutting planes to
interactive_simplex_method
-------------------------------------+-------------------------------------
       Reporter:  mkoeppe            |        Owner:
           Type:  enhancement        |       Status:  needs_work
       Priority:  major              |    Milestone:  sage-6.8
      Component:  numerical          |   Resolution:
       Keywords:                     |    Merged in:
        Authors:  Peijun Xiao        |    Reviewers:  Andrey Novoseltsev
Report Upstream:  N/A                |  Work issues:  doc format
         Branch:                     |       Commit:
  
u/mkoeppe/add_didactical_implementation_of_tableau_cutting_planes_to_interactive_simplex_method|
  933fb3dae2ddc08760f67d98fe21435d3a66364c
   Dependencies:  #18742             |     Stopgaps:
-------------------------------------+-------------------------------------
Changes (by novoselt):

 * status:  needs_review => needs_work
 * reviewer:   => Andrey Novoseltsev
 * work_issues:   => doc format


Comment:

 I hope to take a closer look during upcoming Sage Days, but some picks at
 formatting for now,
 http://doc.sagemath.org/html/en/developer/coding_basics.html
 #documentation-strings has a long example docsctring:

  - there should be empty lines between arguments
  - there should be no empty lines (especially multiple ones) in the very
 beginning and the very end
  - references to other methods should be marked with `:meth:`, `:func:`,
 `:class:` as appropriate
  - the very first line should be a one-line description and if at all
 possible it should take only one line
  - mathematics should be in single back quotes and use of LaTeX is
 encouraged
  - there should be empty lines after `::` and before the test blocks
  - there should be `::` before EVERY test block

 While some of these things are convention/taste/style, others are just
 plain necessary for documentation and testing frameworks to work. As you
 can see from the patchbot result, the current version does not build.

--
Ticket URL: <http://trac.sagemath.org/ticket/18805#comment:5>
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 unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.

Reply via email to