Skip to content

Commit 97b5a21

Browse files
author
Markus Nullmeier
committed
basic spell-checking of the documentation
1 parent 0c4df71 commit 97b5a21

File tree

8 files changed

+34
-34
lines changed

8 files changed

+34
-34
lines changed

doc/appendixes.sgm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</listitem>
1515
<listitem>
1616
<para>
17-
Remove btree index. It was used to cluster the index.
17+
Remove B-tree index. It was used to cluster the index.
1818
</para>
1919
</listitem>
2020
<listitem>

doc/constructors.sgm

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<para>
66
Constructors within <application>pgSphere</application> are
77
functions needed to create spherical data types from other data
8-
types. In usage, there isn't a difference from
8+
types. For actual use, there isn't a difference to
99
<emphasis>usual</emphasis> <application>PostgreSQL</application>
1010
functions. <application>pgSphere</application> constructor
1111
functions are named by returned data type. Constructor functions
@@ -51,7 +51,7 @@
5151
Euler transformation
5252
</title>
5353
<para>
54-
There are two constructor functions for a Euler transformation:
54+
There are two constructor functions for an Euler transformation:
5555
</para>
5656
<funcsynopsis>
5757
<funcprototype>
@@ -77,7 +77,7 @@
7777
For more information about that parameter, see <xref linkend="dt.strans"/>.
7878
</para>
7979
<example>
80-
<title>Create a Euler transformation object</title>
80+
<title>Create an Euler transformation object</title>
8181
<simpara>
8282
Create a transformation object to rotate a spherical object
8383
counterclockwise, first 20&deg; around
@@ -114,7 +114,7 @@
114114
Otherwise, this function returns an error.
115115
</para>
116116
<example>
117-
<title>A circle around the Noth Pole</title>
117+
<title>A circle around the north pole</title>
118118
<simpara>
119119
Get a spherical circle around the North Pole with a radius
120120
of 30&deg;.
@@ -144,7 +144,7 @@
144144
The input of spherical lines using Euler transformation and
145145
length is quite circumstantial (see <xref linkend="dt.sline"/>).
146146
For short lines it is easier to input a line specifying the
147-
begining and the end of the line.
147+
beginning and the end of the line.
148148
</para>
149149
<funcsynopsis>
150150
<funcprototype>

doc/examples.sgm

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@
9191
<para>or</para>
9292
<synopsis> object + strans (&ohgr;, i, &OHgr;)</synopsis>
9393
<example>
94-
<title>Perihel and aphel coordinates of a comet orbit</title>
94+
<title>perihelion and aphelion coordinates of a comet's orbit</title>
9595
<simpara>
9696
We are assuming the orbital elements of a comet are
9797
&OHgr;=30&deg;, i=60&deg; and &ohgr;=90&deg;. We get the
98-
spherical position of perihel and aphel with:
98+
spherical position of perihelion and aphelion with:
9999
</simpara>
100100
<programlisting>
101101
<![CDATA[sql> SELECT set_sphere_output('DEG');]]>
@@ -104,14 +104,14 @@
104104
<![CDATA[ SET DEG]]>
105105
<![CDATA[(1 row)]]>
106106
<![CDATA[]]>
107-
<![CDATA[sql> SELECT spoint '(0,0)' + strans '90d,60d,30d' AS perihel;]]>
108-
<![CDATA[ perihel]]>
107+
<![CDATA[sql> SELECT spoint '(0,0)' + strans '90d,60d,30d' AS perihelion;]]>
108+
<![CDATA[ perihelion]]>
109109
<![CDATA[--------------]]>
110110
<![CDATA[ (120d , 60d)]]>
111111
<![CDATA[(1 row)]]>
112112
<![CDATA[]]>
113-
<![CDATA[sql> SELECT spoint '(180d,0)' + strans '90d,60d,30d' AS aphel;]]>
114-
<![CDATA[ aphel]]>
113+
<![CDATA[sql> SELECT spoint '(180d,0)' + strans '90d,60d,30d' AS aphelion;]]>
114+
<![CDATA[ aphelion]]>
115115
<![CDATA[---------------]]>
116116
<![CDATA[ (300d , -60d)]]>
117117
<![CDATA[(1 row)]]>

doc/functions.sgm

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,15 @@
9595
</funcprototype>
9696
</funcsynopsis>
9797
<para>
98-
return the cartesian
98+
return the Cartesian
9999
<literal>x</literal>, <literal>y</literal> or
100100
<literal>z</literal> value of a spherical position
101101
<parameter>p</parameter>. The returned values are always
102102
between <literal>-1.0</literal> and <literal>+1.0</literal>.
103103
</para>
104104
<example>
105105
<title>
106-
Get the cartesian <literal>z</literal>-value
106+
Get the Cartesian <literal>z</literal>-value
107107
of a spherical point
108108
</title>
109109
<programlisting>
@@ -115,7 +115,7 @@
115115
</programlisting>
116116
</example>
117117
<para>
118-
You can get a <type>float8</type> array of cartesian values using the function
118+
You can get a <type>float8</type> array of Cartesian values using the function
119119
</para>
120120
<funcsynopsis>
121121
<funcprototype>
@@ -125,7 +125,7 @@
125125
</funcsynopsis>
126126
<example>
127127
<title>
128-
Get the cartesian values of a spherical point
128+
Get the Cartesian values of a spherical point
129129
</title>
130130
<programlisting>
131131
<![CDATA[sql> SELECT xyz ( spoint '(0d,0d)' ) AS cart;]]>
@@ -151,14 +151,14 @@
151151
<para>
152152
Using the function
153153
<function>strans_zxz(strans),</function> you can convert
154-
a Euler transformation to <literal>ZXZ</literal>-axes
154+
an Euler transformation to <literal>ZXZ</literal> axes
155155
transformation.
156156
</para>
157157
<example>
158158
<title>Change the transformation axes to <literal>ZXZ</literal></title>
159159
<simpara>
160160
Convert the transformation <literal>strans '20d, -270d, 70.5d,
161-
XZY'</literal> to a <literal>ZXZ</literal>-transformation.
161+
XZY'</literal> to a <literal>ZXZ</literal> transformation.
162162
</simpara>
163163
<programlisting>
164164
<![CDATA[sql> SELECT strans_zxz ( strans '20d, -270d, 70.5d, XZY' );]]>
@@ -502,7 +502,7 @@
502502
</title>
503503
<sect3 id="funcs.spoly.npts">
504504
<title>
505-
Cnunt of edges
505+
Count of edges
506506
</title>
507507
<para>
508508
Similar to an <type>spath</type> (<xref linkend="funcs.spath.npts"/>),

doc/indices.sgm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</title>
99
<para>
1010
<application>pgSphere</application> uses <literal>GiST</literal>
11-
to create spherical indices. An index speeds up the executation
11+
to create spherical indices. An index speeds up the execution
1212
time of operators <link
1313
linkend="op.over"><literal>@</literal></link>, <link
1414
linkend="op.over"><literal>&amp;&amp;</literal></link>, <link

doc/install.sgm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
Then, change into <filename>POSTGRESQL_SRC/src/contrib</filename>.
3333
If the sources are not yet installed and the directory
3434
<filename>pg_sphere</filename> does not exist, take the
35-
gzipped <application>pgSphere</application> sources ( e.g.,
35+
gzipped <application>pgSphere</application> sources ( e. g.,
3636
<filename>pg_sphere_xxx.tgz</filename> ) and run:
3737
</para>
3838
<programlisting>

doc/operators.sgm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@
307307
</title>
308308
<para>
309309
The length/circumference operator <literal>@-@</literal> is
310-
a non-boolean unary operator returning the cirumference or
310+
a non-boolean unary operator returning the circumference or
311311
length of an object. In the current implementation,
312312
<application>pgSphere</application> supports only
313313
circumferences of circles, polygons, and boxes. It supports
@@ -365,7 +365,7 @@
365365
<para>
366366
The unary operator <literal>-</literal> changes the
367367
direction of <type>sline</type> or <type>spath</type>
368-
objects. You can use it with a Euler transformation object
368+
objects. You can use it with an Euler transformation object
369369
in the figurative sense, too (<xref linkend="op.trans"/>).
370370
</para>
371371
<example>

doc/types.sgm

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
</imageobject>
106106
</mediaobject>
107107
A spherical point is an object without expanse
108-
but with a position. Usage cases are:
108+
but with a position. Use cases are:
109109
</para>
110110
<itemizedlist>
111111
<listitem>
@@ -194,10 +194,10 @@
194194
<imagedata fileref="&graph1003;" width="160px" format="JPEG"/>
195195
</imageobject>
196196
</mediaobject>
197-
A Euler transformation is done with three counterclockwise
197+
An Euler transformation is done with three counterclockwise
198198
object rotations around following the axes:
199199
<literal>x</literal>-axis, <literal>y</literal>-axis, or
200-
<literal>z</literal>-axis. Usage cases are:
200+
<literal>z</literal>-axis. Use cases are:
201201
</para>
202202
<itemizedlist>
203203
<listitem>
@@ -212,7 +212,7 @@
212212
</listitem>
213213
</itemizedlist>
214214
<para>
215-
The input syntax of a Euler transformation is:
215+
The input syntax of an Euler transformation is:
216216
</para>
217217
<synopsis>angle1, angle2, angle3 &lsqb;, axes &rsqb;</synopsis>
218218
<para>
@@ -269,7 +269,7 @@
269269
</mediaobject>
270270
A spherical circle is an area
271271
around a point, where all points inside the circle have a
272-
distance less than or equal to the radius of the circle. Usage
272+
distance less than or equal to the radius of the circle. Use
273273
cases are:
274274
</para>
275275
<itemizedlist>
@@ -323,7 +323,7 @@
323323
</imageobject>
324324
</mediaobject>
325325
A spherical line is part of a great circle (meridian) that has
326-
a beginning and an end and hence, a direction. Usage cases are:
326+
a beginning and an end and hence, a direction. Use cases are:
327327
</para>
328328
<itemizedlist>
329329
<listitem>
@@ -345,7 +345,7 @@ i syntax is a somewhat complex.
345345
A general located line with a length
346346
<parameter>length</parameter> is defined as a line starting at
347347
position <literal>(0d,0d)</literal> and ending at position
348-
<literal>(length,0d)</literal> transformed with a Euler
348+
<literal>(length,0d)</literal> transformed with an Euler
349349
transformation <parameter>euler</parameter>. The input syntax
350350
is :
351351
</para>
@@ -369,7 +369,7 @@ i syntax is a somewhat complex.
369369
<listitem>
370370
<para>
371371
The transformation <parameter>euler</parameter>
372-
will always be converted to a Euler
372+
will always be converted to an Euler
373373
transformation using axes <literal>Z</literal>,
374374
<literal>X</literal>, and <literal>Z</literal>.
375375
</para>
@@ -413,7 +413,7 @@ i syntax is a somewhat complex.
413413
</para>
414414
</blockquote>
415415
<para>
416-
Usage cases are:
416+
Use cases are:
417417
</para>
418418
<itemizedlist>
419419
<listitem>
@@ -510,7 +510,7 @@ i syntax is a somewhat complex.
510510
</imageobject>
511511
</mediaobject>
512512
A spherical path is a
513-
concatination of spherical lines. Usage cases are:
513+
concatenation of spherical lines. Use cases are:
514514
</para>
515515
<itemizedlist>
516516
<listitem>
@@ -573,7 +573,7 @@ i syntax is a somewhat complex.
573573
<para>
574574
A spherical polygon is a
575575
closed spherical path where line segments cannot be crossed.
576-
One main usage case are areas on the earth and sky sphere.
576+
One main use case are areas on the earth and sky sphere.
577577
Polygons within <application>pgSphere</application>
578578
have the same input syntax as paths:
579579
</para>

0 commit comments

Comments
 (0)