Comments and formatting only

Author: dmullis

canvas.go

@@ -1,3 +1,18 @@
+
+/*
+Package goat formats "ASCII-art" drawings into Github-flavored Markdown.
+
+<goat>
+    Internal Data Flow
+
+                            Canvas{}          WriteSVGBody()       SVG{}	           
+          NewCanvas()   .-----------------.     .-------.     .-------------.
+ ASCII-art    .--.     | data map[x,y]rune |   |         |    |             |  Markdown
+  ---------->|    +--->| text map[x,y]rune |-->|         +--->| Body string +----->
+              '--'     |                   |   |         |    |             |
+                        '-----------------'     '-------'     '-------------'
+</goat>
+*/
 package goat
 
 import (
@@ -133,8 +148,8 @@ func (c *Canvas) runeAt(i Index) rune {
 
 // NewCanvas creates a new canvas with contents read from the given io.Reader.
 // Content should be newline delimited.
-//  XX  Move this to top of file.
 func NewCanvas(in io.Reader) (c Canvas) {
+	//  XX  Move this function to top of file.
 	width := 0
 	height := 0
 
@@ -201,7 +216,7 @@ type Drawable interface {
 
 // Line represents a straight segment between two points 'start' and 'stop', where
 // 'start' is either lesser in X (north-east, east, south-east), or
-//  equal in X and lesser in Y (south).
+// equal in X and lesser in Y (south).
 type Line struct {
 	start Index
 	stop  Index
@@ -302,7 +317,7 @@ type Text struct {
 	str	 string	 // Possibly multiple bytes, from Unicode source of type 'rune'
 }
 
-// Bridge correspondes to combinations of "-)-" or "-(-" and is displayed as
+// Bridge corresponds to combinations of "-)-" or "-(-" and is displayed as
 // the vertical line "hopping over" the horizontal.
 type Bridge struct {
 	start	    Index

cmd/goat/main.go

@@ -56,7 +56,7 @@ func main() {
 	if outputFilename != "" {
 		var err error
 		output, err = os.Create(outputFilename)
-		defer output.Close()
+		defer output.Close()          // XX  Move outside 'if' -- close os.Stdout as well?
 		if err != nil {
 			log.Fatal(err)
 		}

cmd/tmpl-expand/main.go

@@ -31,7 +31,7 @@ type (
 // General args
 var (
 	writeMarkdown = flag.Bool("markdown", false,
-		`Write out usage doc in Github-flavored Markdown format`)
+		`Reformat -help usage message into Github-flavored Markdown`)
 
 	exitStatus int
 )

svg.go

@@ -1,3 +1,4 @@
+// All output is buffered into the object SVG, then written to the output stream.
 package goat
 
 import (
@@ -21,24 +22,24 @@ svg {
    color: %s;
 }
 @media (prefers-color-scheme: dark) {
-     svg {
-   color: %s;
-     }
+   svg {
+      color: %s;
+   }
 }
 </style>`,
 		svgColorLightScheme,
 		svgColorDarkScheme)
 
 	return fmt.Sprintf(
-		"<svg class='%s' xmlns='%s' version='%s' height='%d' width='%d' font-family='Menlo,Lucida Console,monospace'>\n" +
+		"<svg xmlns='%s' version='%s' height='%d' width='%d' font-family='Menlo,Lucida Console,monospace'>\n" +
 			"%s\n" +
 			"%s</svg>\n",
-		"diagram",  // XX  can this have any effect?
 		"http://www.w3.org/2000/svg",
 		"1.1", s.Height, s.Width, style, s.Body)
 }
 
-// BuildSVG reads in a newline-delimited ASCII diagram from src and returns an SVG.
+// BuildSVG reads a newline-delimited ASCII diagram from src and returns an
+// initialized SVG struct.
 func BuildSVG(src io.Reader) SVG {
 	var buff bytes.Buffer
 	canvas := NewCanvas(src)
@@ -53,7 +54,7 @@ func BuildSVG(src io.Reader) SVG {
 // BuildAndWriteSVG reads in a newline-delimited ASCII diagram from src and writes a
 // corresponding SVG diagram to dst.
 func BuildAndWriteSVG(src io.Reader, dst io.Writer,
-	svgColorLightScheme string, svgColorDarkScheme string) {
+	svgColorLightScheme, svgColorDarkScheme string) {
 	svg := BuildSVG(src)
 	writeBytes(dst, svg.String(svgColorLightScheme, svgColorDarkScheme))
 }
@@ -70,12 +71,12 @@ func writeBytes(out io.Writer, format string, args ...interface{}) {
 func writeText(out io.Writer, canvas *Canvas) {
 	writeBytes(out,
 		`<style>
-text {
+  text {
        text-anchor: middle;
        font-family: "Menlo","Lucida Console","monospace";
        fill: currentColor;
        font-size: 1em;
-}
+  }
 </style>
 `)
 	for _, textObj := range canvas.Text() {