cookbook documentation chapter: coding theory

[wdjoyner]

I've put a draft for the coding theory chapter for the cookbook.tex document in
http://sage.math.washington.edu/home/wdj/cookbook/
To possibly make it easier, I've created this tarball of the directory:
http://sage.math.washington.edu/home/wdj/cookbook2008-07-09.tar.gz

Component: documentation

Author: Ralf Stephan

Branch/Commit: 66c7d05

Reviewer: Kannappan Sampath

Issue created by migration from https://trac.sagemath.org/ticket/3624

[sagetrac-mabshoff]

comment:1

This is unrelated to coercion and should not be assigned against the coercion milestone. Right now 3.0.6 is the default milestone, so please assign new tickets against that milestone.

Cheers,

Michael

[sagetrac-mabshoff]

comment:2

Is this TeX code stand alone or is there a patch in there somewhere for the new cookbook? If so we should create the cookbook and migrate chapter by chapter over from the old construction manual. Once that is done we remove const.tex and all the other bits related to it.

Cheers,

Michael

[wdjoyner]

comment:3

I put a standalone latex file there (http://sage.math.washington.edu/home/wdj/cookbook/coding-theory/sage-coding-cookbook.tex) for just that chapter (not in manual style) but also the full latex setup for a new subdirectory of SAGE_ROOT/devel/doc. I don't know how to make a patch to add a cookbook subdirectory to devel/doc. The programming guide discusses adding new files at http://sage.scipy.org/sage/doc/html/prog/node72.html The book http://hgbook.red-bean.com/hgbook.html is hard to search through since the index is for page numbers but the html is in sections, not page numbers.

[sagetrac-mvngu]

fixes typos in sage-coding-cookbook.tex

[sagetrac-mvngu]

comment:4

Attachment: 3624-doc.patch.gz

Replying to @wdjoyner:

I put a standalone latex file there (http://sage.math.washington.edu/home/wdj/cookbook/coding-theory/sage-coding-cookbook.tex) for just that chapter (not in manual style) but also the full latex setup for a new subdirectory of SAGE_ROOT/devel/doc.

I've attached a patch to your file sage-coding-cookbook.tex. It mainly fixes typos. I'm still waiting for sage-3.1.4 to finish building on my machine, so at the moment I can't review the sample code in your file.

[sagetrac-mvngu]

comment:6

Ticket #8466 supersedes the current ticket.

[rwst]

Branch: u/rws/ticket/3624

[rwst]

comment:10

I took the latest corrected version of the paper, converted it to ReST using pandoc, and fixed that document, including a few typos. I converted the EPS figures to PNG using inkscape. The file is included in the toctree and the general index under number theory because I didn't want a toplevel entry. Maybe replace number theory with discrete math?

---

New commits:

32fe924

Trac #3624: added rst version of tex paper; include in indices

[rwst]

Author: Ralf Stephan

[rwst]

Commit: 32fe924

[rwst]

comment:12

sage -t --long src/doc/en/thematic_tutorials/coding_theory.rst
    Error: TAB character found at lines 860,864,865,.,.,.,1064

+Included in Sage is the group theory package GAP [GAP]_ and GUAVA [GUAVA]_, GA
P’s coding
+theory package. All of GUAVA’s functions can be accessed within Sage.
+   (calling Steve Linton’s C programs in GAP),
+#. Boolean-valueTraceback (most recent call last):
  File "/home/ralf/sage/local/bin/patchbot/patchbot.py", line 468, in test_a_ticket
    res = plugin(ticket, is_git=True, baseline=baseline, **kwds)
  File "/home/ralf/git/sage-patchbot/src/plugins.py", line 149, in non_ascii
    exclude_new(ticket, regex=r'[^\x00-\x7F]', msg="Non-ascii characters", **kwds)
  File "/home/ralf/git/sage-patchbot/src/plugins.py", line 143, in exclude_new
    raise ValueError(full_msg)
ValueError: Non-ascii characters inserted on 35 non-empty lines

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

a4b82e6	Merge branch 'develop' into t/3624/ticket/3624
48079fa	replace tabs, nonascii chars

[sagetrac-git]

Changed commit from 32fe924 to 48079fa

[KPanComputes]

comment:16

Could you please rebase this on top of current release (and/or tell me how to do it)? This would be immensely helpful.

/p/s/ This should be an easy review for me but I have forgotten how to rebase a branch on top of another.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

d1b2487

Merge branch 'develop' into t/3624/ticket/3624

[sagetrac-git]

Changed commit from 48079fa to d1b2487

[KPanComputes]

Reviewer: Kannappan Sampath

[KPanComputes]

comment:18

I am setting this to Positive Review! Thank to the authors and editor for the great work on this branch!

[rwst]

comment:19

Thanks for the review!

[vbraun]

comment:20

PDF docs don't build

l.14519 \end{gather}
                    
? 
! Emergency stop.
\math@cr@@@ ...@ \@ne \add@amps \maxfields@ \omit 
                                                  \kern -\alignsep@ \iftag@ ...
l.14519 \end{gather}
                    
!  ==> Fatal error occurred, no output PDF file produced!
Transcript written on thematic_tutorials.log.
 [23make[1]: *** [thematic_tutorials.pdf] Error 1
make[1]: Leaving directory `/home/release/Sage/src/doc/output/latex/en/thematic_tutorials'
]

[sagetrac-git]

Changed commit from d1b2487 to 66c7d05

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

66c7d05

3624: rename images, fix math

[rwst]

comment:22

I really thought I had tested this.

[vbraun]

Changed branch from u/rws/ticket/3624 to 66c7d05