Opened 3 years ago
Closed 3 years ago
#21306 closed enhancement (fixed)
Improve documentation for divisor method in linear_code.py
Reported by:  ralfaro  Owned by:  

Priority:  trivial  Milestone:  sage7.4 
Component:  coding theory  Keywords:  sd75 
Cc:  Merged in:  
Authors:  Ricardo Alfaro  Reviewers:  Fangan Dosso 
Report Upstream:  N/A  Work issues:  
Branch:  412f945 (Commits)  Commit:  412f9454adbbb98639421613515290308b44a80b 
Dependencies:  Stopgaps: 
Description
There was no explanation of what A_i meant. This is the number of codewords of weight i, so we rewrote the documentation to avoid the A_i syntax.
Change History (5)
comment:1 Changed 3 years ago by
 Branch set to u/ralfaro/fix_docs_divisor
comment:2 Changed 3 years ago by
 Commit set to 7b1b3ec5b6042c57a1d1af4d17e8c081b900572f
 Status changed from new to needs_review
comment:3 Changed 3 years ago by
 Commit changed from 7b1b3ec5b6042c57a1d1af4d17e8c081b900572f to 412f9454adbbb98639421613515290308b44a80b
Branch pushed to git repo; I updated commit sha1. New commits:
412f945  Change and correct documentation for divisor of a code.

comment:4 Changed 3 years ago by
 Reviewers set to Fangan Dosso
 Status changed from needs_review to positive_review
I tested the method. It works correctly. Also, the documentation compiles well.
Changed to positive review.
comment:5 Changed 3 years ago by
 Branch changed from u/ralfaro/fix_docs_divisor to 412f9454adbbb98639421613515290308b44a80b
 Resolution set to fixed
 Status changed from positive_review to closed
Note: See
TracTickets for help on using
tickets.
The current documentation calls for smallest integer when it should be largest. Also, no reference to what Ai was, so we rewrote the definition without using A_i.