#13667: fix docs in sage/coding/code_bounds.py
---------------------------------+------------------------------------------
       Reporter:  dimpase        |         Owner:  mvngu       
           Type:  defect         |        Status:  needs_review
       Priority:  major          |     Milestone:  sage-5.7    
      Component:  documentation  |    Resolution:              
       Keywords:  code bounds    |   Work issues:              
Report Upstream:  N/A            |     Reviewers:              
        Authors:                 |     Merged in:              
   Dependencies:                 |      Stopgaps:              
---------------------------------+------------------------------------------
Changes (by ppurka):

  * status:  needs_work => needs_review


Old description:

> In {{{sage/coding/code_bounds.py}}} there is a comment:
> {{{
>  (1) Indirectly, using minimum_distance_lower_bound(n,k,F) and
>  minimum_distance_upper_bound(n,k,F) (both of which which connect
>  to the internet using Steven Sivek's linear_code_bound(q,n,k))
> }}}
>
> However, linear_code_bound (in databases/lincodes.py) is completely
> commented out.
> This happened more than 5 years ago:
> {{{
> $ hg blame databases/lincodes.py | grep def\ linear_code_bound
>  4858: ## def linear_code_bound(q, n, k, verbose=False):
>
> $ hg log -g -r 4858 databases/lincodes.py
> changeset:   4858:60ac2a91b36d
> parent:      4856:9c651ca8064d
> user:        William Stein <[email protected]>
> date:        Sat Jun 02 20:45:05 2007 -0700
> summary:     doctest fixes
> }}}
>
> There are up-to-date (and much bigger) tables on
> http://www.codetables.de/
> maintained by Markus Grassl (who took over from Andries Brouwer his
> tables---
> used by  {{{linear_code_bound}}}). They are hooked up in
> {{{sage/coding/linear_code.py}}}, function
> {{{best_known_linear_code_www()}}}.
>
> So {{{sage/coding/code_bounds.py}}} should mention this, and not the
> obsolete stuff.

New description:

 In {{{sage/coding/code_bounds.py}}} there is a comment:
 {{{
  (1) Indirectly, using minimum_distance_lower_bound(n,k,F) and
  minimum_distance_upper_bound(n,k,F) (both of which which connect
  to the internet using Steven Sivek's linear_code_bound(q,n,k))
 }}}

 However, linear_code_bound (in databases/lincodes.py) is completely
 commented out.
 This happened more than 5 years ago:
 {{{
 $ hg blame databases/lincodes.py | grep def\ linear_code_bound
  4858: ## def linear_code_bound(q, n, k, verbose=False):

 $ hg log -g -r 4858 databases/lincodes.py
 changeset:   4858:60ac2a91b36d
 parent:      4856:9c651ca8064d
 user:        William Stein <[email protected]>
 date:        Sat Jun 02 20:45:05 2007 -0700
 summary:     doctest fixes
 }}}

 There are up-to-date (and much bigger) tables on http://www.codetables.de/
 maintained by Markus Grassl (who took over from Andries Brouwer his
 tables---
 used by  {{{linear_code_bound}}}). They are hooked up in
 {{{sage/coding/linear_code.py}}}, function
 {{{best_known_linear_code_www()}}}.

 So {{{sage/coding/code_bounds.py}}} should mention this, and not the
 obsolete stuff.

 ----

 Apply to devel/sage
 1. [attachment:trac_13667.patch]
 2. [attachment:trac_13667-review.patch]

--

Comment:

 Added a review patch with some extra explanation.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13667#comment:7>
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?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to