Doc patch "only relevant" -> "relevant only"
Hi,
As long as I'm sending in trivial fixes
to the docs here's a bit of wording that's been bugging me.
In a number of places the docs read "only relevant",
this patch reverses this to read "relevant only".
I believe this reads better because it quickly
answers the question "is what?" with "is relevant",
making the sentence less of a strain to read.
"Only relevant" would be better if you really wanted
to emphasize the "only", which I don't think is called
for.
(Sending in such trivial patches makes me feel like
I'm bikeshedding. Feel free to ignore them without comment.)
Regards,
Karl <kop@meme.com>
Free Software: "You don't pay back, you pay forward."
-- Robert A. Heinlein
Attachments:
doc_only_relevant.patchtext/x-patch; charset=us-ascii; name=doc_only_relevant.patchDownload
diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml
index 71cf59e..02763b5 100644
--- a/doc/src/sgml/datatype.sgml
+++ b/doc/src/sgml/datatype.sgml
@@ -3596,7 +3596,7 @@ SELECT person.name, holidays.num_weeks FROM person, holidays
as the canonical form for MAC addresses, and specifies the first
form (with colons) as the bit-reversed notation, so that
08-00-2b-01-02-03 = 01:00:4D:08:04:0C. This convention is widely
- ignored nowadays, and it is only relevant for obsolete network
+ ignored nowadays, and it is relevant only for obsolete network
protocols (such as Token Ring). PostgreSQL makes no provisions
for bit reversal, and all accepted formats use the canonical LSB
order.
diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml
index 4503830..b19f15e 100644
--- a/doc/src/sgml/ref/pg_dump.sgml
+++ b/doc/src/sgml/ref/pg_dump.sgml
@@ -427,7 +427,7 @@ PostgreSQL documentation
<listitem>
<para>
Specify the superuser user name to use when disabling triggers.
- This is only relevant if <option>--disable-triggers</> is used.
+ This is relevant only if <option>--disable-triggers</> is used.
(Usually, it's better to leave this out, and instead start the
resulting script as superuser.)
</para>
@@ -602,7 +602,7 @@ PostgreSQL documentation
<term><option>--disable-triggers</></term>
<listitem>
<para>
- This option is only relevant when creating a data-only dump.
+ This option is relevant only when creating a data-only dump.
It instructs <application>pg_dump</application> to include commands
to temporarily disable triggers on the target tables while
the data is reloaded. Use this if you have referential
diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml
index 7c49c03..253ee01 100644
--- a/doc/src/sgml/ref/pg_dumpall.sgml
+++ b/doc/src/sgml/ref/pg_dumpall.sgml
@@ -190,7 +190,7 @@ PostgreSQL documentation
<listitem>
<para>
Specify the superuser user name to use when disabling triggers.
- This is only relevant if <option>--disable-triggers</> is used.
+ This is relevant only if <option>--disable-triggers</> is used.
(Usually, it's better to leave this out, and instead start the
resulting script as superuser.)
</para>
@@ -283,7 +283,7 @@ PostgreSQL documentation
<term><option>--disable-triggers</></term>
<listitem>
<para>
- This option is only relevant when creating a data-only dump.
+ This option is relevant only when creating a data-only dump.
It instructs <application>pg_dumpall</application> to include commands
to temporarily disable triggers on the target tables while
the data is reloaded. Use this if you have referential
diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml
index b276da6..2993369 100644
--- a/doc/src/sgml/ref/pg_restore.sgml
+++ b/doc/src/sgml/ref/pg_restore.sgml
@@ -383,7 +383,7 @@
<listitem>
<para>
Specify the superuser user name to use when disabling triggers.
- This is only relevant if <option>--disable-triggers</> is used.
+ This is relevant only if <option>--disable-triggers</> is used.
</para>
</listitem>
</varlistentry>
@@ -458,7 +458,7 @@
<term><option>--disable-triggers</></term>
<listitem>
<para>
- This option is only relevant when performing a data-only restore.
+ This option is relevant only when performing a data-only restore.
It instructs <application>pg_restore</application> to execute commands
to temporarily disable triggers on the target tables while
the data is reloaded. Use this if you have referential
On 10/16/2012 11:24 PM, Karl O. Pinc wrote:
Hi,
As long as I'm sending in trivial fixes
to the docs here's a bit of wording that's been bugging me.In a number of places the docs read "only relevant",
this patch reverses this to read "relevant only".I believe this reads better because it quickly
answers the question "is what?" with "is relevant",
making the sentence less of a strain to read.
"Only relevant" would be better if you really wanted
to emphasize the "only", which I don't think is called
for.(Sending in such trivial patches makes me feel like
I'm bikeshedding. Feel free to ignore them without comment.)
This doesn't appear to correct any ambiguity, nor any grammatical error.
I find these sentences perfectly readable as they are. Not everything in
the docs conforms to my personal style either, but I'm not in favor of
taking this sort of patch which is just a matter of substituting your
stylistic judgment for that for the original author. If we do that we'll
never stop.
cheers
andrew
At 2012-10-17 09:19:58 -0400, andrew@dunslane.net wrote:
This doesn't appear to correct any ambiguity, nor any grammatical
error.
FWIW, it's quite standard and uncontroversial "good writing" advice to
push "only" as far right as it can go. It does correct an ambiguity,
but in this case the ambiguity is silly and harmless, so fixing it
seems like nitpicking when you read the patch.
-- Abhijit
P.S. I would fix it anyway.
