Pikchr

Some more small corrections
Login

Some more small corrections

(1) By brickviking on 2023-05-26 08:23:57 [source]

A collection of stuff I found

circleobj.md

I spotted an ambiguity in circleobj.md, but I'm not sure how it could be best addressed.

# Circle objects

A is defined by one of:

I think the sentence could be rewritten in one of two forms, depending on the outcome.

Circle A is defined by one of:

if you were to refer to the circle A inside the pikchr below, or instead:

A circle object is defined by one of:

if you were to roughly duplicate the first phrase of boxobj.md.


differences.md

In differences.md, there's a word "proprocessor" I haven't heard before.

Index: doc/differences.md
==================================================================
--- doc/differences.md
+++ doc/differences.md
@@ -429,3 +429,3 @@
 
-The token limit is determined by the PIKCHR_TOKEN_LIMIT proprocessor
+The token limit is determined by the PIKCHR_TOKEN_LIMIT preprocessor
 macro in the source code.  The default token limit is 100000, which

download.md

At the bottom, this file has this:

There is a (read-only) mirror of this repository on GitHub

 *  <https://github.com/drhsqlite/pikchr>

Would it look better with a colon on the end of the sentence?

There is a (read-only) mirror of this repository on GitHub:


ellipseobj.md

One single missing letter here:

Index: doc/ellipseobj.md
==================================================================
--- doc/ellipseobj.md
+++ doc/ellipseobj.md
@@ -19,3 +19,3 @@
 Curiously, the "radius" has no effect on the shape of an ellipse.
-The ellipse is determine solely by the width and height.  If the
+The ellipse is determined solely by the width and height.  If the
 width and height are equal, the ellipse degenerates into a circle.

linelen.md

Here, there's a possible missing colon at the end of this sentence just before the list:

Index: doc/linelen.md
==================================================================
--- doc/linelen.md
+++ doc/linelen.md
@@ -12,3 +12,3 @@
 value stored in the "`linewid`" variable.  However, for a case of
-either
+either:


pathattr.md

Again, a missing word here, as well as a missing full stop further down.

Index: doc/pathattr.md
==================================================================
--- doc/pathattr.md
+++ doc/pathattr.md
@@ -2,3 +2,3 @@
 
-A *path-attribute* is used provide the origin and direction of a line
+A *path-attribute* is used to provide the origin and direction of a line
 object (arc, arrow, line, move, or spline).  It is an error to use a
@@ -91,3 +91,3 @@
 coordinate being changed matches the corresponding coordinate in
-*position* If the line is going up or down, then it continues until
+*position*. If the line is going up or down, then it continues until
 the Y coordinate matches the Y coordinate of *position*.  If the line

stmt.md

I'm pretty sure this is meant to be different:

Index: doc/stmt.md
==================================================================
--- doc/stmt.md
+++ doc/stmt.md
@@ -111,3 +111,3 @@
 | rightmargin   | Extra border space added to the right side of the diagram  |
-| topmargin     | Extra border space added to top top side of the diagram    |
+| topmargin     | Extra border space added to the top side of the diagram    |
 


stmtlist.md

Again, a missing word here:

Index: doc/stmtlist.md
==================================================================
--- doc/stmtlist.md
+++ doc/stmtlist.md
@@ -67,3 +67,3 @@
 
-Whitespace other a newline is ignored.  If a backslash is followed
+Whitespace other than a newline is ignored.  If a backslash is followed
 by one or more whitespace characters ending in a newline, then the


teardown01.md

There's a couple of things here. One's a missing word:

Index: doc/teardown01.md
==================================================================
--- doc/teardown01.md
+++ doc/teardown01.md
@@ -84,3 +84,3 @@
 the first one to fit the text, line 05 sets the new default circle radius
-for all subsequent circles to be same as the first circle.  This
+for all subsequent circles to be the same as the first circle.  This
 not only saves us from having to add a "fit" on every "circle" call, it means

The other is a nesting level problem, although I'm not sure if that was actually intentional and not an error.

Index: doc/teardown01.md
==================================================================
--- doc/teardown01.md
+++ doc/teardown01.md
@@ -171,3 +171,3 @@
 
-# Lines 22 through 26 - background color for trunk
+## Lines 22 through 26 - background color for trunk
 
@@ -210,3 +210,3 @@
 
-# Lines 27 through 29 - background color for the branches
+## Lines 27 through 29 - background color for the branches

userman.md

There's also a couple of changes here, the first is obvious, the second not so much.

Index: doc/userman.md
==================================================================
--- doc/userman.md
+++ doc/userman.md
@@ -16,3 +16,3 @@
 The design goal of Pikchr is to enable embedded line diagrams in Markdown or other
-simple markup languages.  The details on how to embedded Pikchr in Markdown is
+simple markup languages.  The details on how to embed Pikchr in Markdown is
 [covered separately][embed].  For the purpose of this tutorial, we will only write

This second change is because the original sentence intimated that two "small" would also make the text far bigger.

Two "big" attributes cause the text to be larger still, as do two "small" attributes.

Index: doc/userman.md
==================================================================
--- doc/userman.md
+++ doc/userman.md
@@ -1196,4 +1196,4 @@
 The "`big`" and "`small`" attributes cause the text to be a little larger
-or a little smaller, respectively.  Two "`big`" attributes cause the
-text to be larger still, as do two "`small`" attributes. Text
+or a little smaller, respectively.  Two "`big`" attributes cause the text
+to be larger still, and two "`small`" attributes make it smaller still. Text
 size does not increase or decrease beyond two "`big`" or "`small`" keywords.

Wrap-up

I think that's pretty much all the tiny little niptucks I could find. I hope that will work for you.

Cheers, brickviking

(Post 2)

(2) By Warren Young (wyoung) on 2023-05-26 09:28:13 in reply to 1 [link] [source]

Fixed; thanks!

(3) By brickviking on 2023-05-26 11:14:42 in reply to 1 [link] [source]

It seemed I missed another grammo, which was sitting right in front of my face. I'd even made an edit on the previous sentence.

Index: doc/circleobj.md
==================================================================
--- doc/circleobj.md
+++ doc/circleobj.md
@@ -9,3 +9,3 @@
 
-Only one of these values can set for any particular circle; the others 
+Only one of these values can be set for any particular circle; the others 
 are determined automatically by the first.

Sorry about missing this one.

Cheers, brickviking

(Post 3)

(4) By Warren Young (wyoung) on 2023-05-26 11:38:01 in reply to 3 [link] [source]

Also fixed; thanks!