[MERGE] Fixing Typos in documentation

Thu Feb 19 15:02:33 GMT 2009

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Ben Finney wrote:
...

>> @@ -114,7 +114,7 @@
>>  
>>      def create_repository(self, shared=False):
>>          # as per meta1 formats - just delegate to the format object which may
>> -        # be parameterised.
>> +        # be parameterized.
> 
> Is there a need for this? Many other “ise/ize” discrepancies exist,
> why focus on only a few?

I'll also mention that are code is split on this. We started out in
primarily American English with ize. However, when Robert worked on pack
repositories, he decided to go with ise everywhere. I've tried to just
maintain consistency *within* a source file (and probably within logical
functional groups).

Note that this even bleed into on-disk structures which we cannot easily
change (the directory .bzr/repository/indices rather than
.bzr/repository/indexes).

I'm not against trying to find some sort of common ground, but as we are
a bit split internally, and in ways that would cause on-disk level
incompatibility, I've decided to just live with it.

> 
>> @@ -918,7 +918,7 @@
>>              # the user will almost certainly have seen a warning about the
>>              # server version already.
>>              rg = self.get_revision_graph()
>> -            # There is an api discrepency between get_parent_map and
>> +            # There is an api discrepancy between get_parent_map and
> 
> Might as well correct the initialism to use the correct case:
> 
>     There is an API discrepancy between get_parent_map and
> 
>> === modified file 'bzrlib/tests/__init__.py'
>> --- bzrlib/tests/__init__.py	2009-02-19 01:41:43 +0000
>> +++ bzrlib/tests/__init__.py	2009-02-19 10:29:06 +0000
>> @@ -992,7 +992,7 @@
>>                  raise AssertionError("%r is %r." % (left, right))
>>  
>>      def assertTransportMode(self, transport, path, mode):
>> -        """Fail if a path does not have mode mode.
>> +        """Fail if a path does not have mode.
> 
> Another instance where markup would make intent clearer.
> 
>     Fail if a path does not have mode `mode`.
> 
>> @@ -856,7 +856,7 @@
>>          """Merge from a branch into this working tree.
>>  
>>          :param branch: The branch to merge from.
>> -        :param to_revision: If non-None, the merge will merge to to_revision,
>> +        :param to_revision: If non-None, the merge will merge to_revision,
>>              but not beyond it. to_revision does not need to be in the history
> 
> The original seems to be correct as is.
> 
>> === modified file 'doc/developers/planned-performance-changes.txt'
>> --- doc/developers/planned-performance-changes.txt	2007-06-19 00:48:22 +0000
>> +++ doc/developers/planned-performance-changes.txt	2009-02-18 11:05:38 +0000
>> @@ -50,7 +50,7 @@
>>     considered a cache this is not exposed in such a way that cache operations
>>     like 'drop the cache' can be performed. On current disk formats the cache is
>>     mandatory, but an API to manage would allow refreshing of the cache (e.g.
>> -   after ghosts are filled in in baz conversions).
>> +   after ghosts are filled in baz conversions).
> 
> Another case where possibly the original is correct as is; “filled in”
> is a phrasal verb, and “in baz conversions” is a modifier specifying
> a condition when that verb occurs. Could perhaps be phrased better:
> 
>     after ghosts are filled in during baz conversions).
> 
>> === modified file 'doc/en/user-guide/solo_intro.txt'
>> --- doc/en/user-guide/solo_intro.txt	2007-11-23 05:52:03 +0000
>> +++ doc/en/user-guide/solo_intro.txt	2009-02-17 12:04:09 +0000
>> @@ -5,7 +5,7 @@
>>  ----------------------------
>>  
>>  Some tools are designed to make individuals productive (e.g. editors)
>> -while other tools (e.g. back-end services) are focussed on making teams
>> +while other tools (e.g. back-end services) are focused on making teams
> 
> Fine as is in the original. (This is another en_UK vs. en_US variation.)
> 
>> === modified file 'doc/en/user-guide/using_gatekeepers.txt'
>> --- doc/en/user-guide/using_gatekeepers.txt	2007-11-23 15:45:20 +0000
>> +++ doc/en/user-guide/using_gatekeepers.txt	2009-02-17 12:04:09 +0000
>> @@ -22,7 +22,7 @@
>>  acceptable, indeed common, to have multiple central branches with
>>  different gatekeepers, e.g. one branch for the current production
>>  release and another for the next release. In this case, a task branch
>> -holding a bug fix will most likely be advertized to both gatekeepers.
>> +holding a bug fix will most likely be advertised to both gatekeepers.
> 
> I think this is evidence that even you aren't decided on which of
> “-ise” or “-ize” you are aiming for :-)

I'll note that "advertised" is the correct American English spelling.
While "parameterized" is *also* the correct American English spelling.
So while he may not have settled, neither has en_US. His spelling
correction here is correct according to en_US.

> 
> 
> Thanks for these changes. I wonder what caused so many doubled-up words?
> 

Possibly just the human behavior of ignoring them. When reading a
sentence we can easily not even notice doubled words, especially if they
wrap across a line.

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkmddIkACgkQJdeBCYSNAAM7mgCfXW/L9LBirL32cD9l+GVjqSw4
1ywAni/Zt64e7rTZsK6xKTr/b1CxHDN6
=xo+q
-----END PGP SIGNATURE-----