changeset 17425:e95ec38f86b0

fix wording and not-completely-trivial spelling errors and bad docstrings
author Mads Kiilerich <mads@kiilerich.com>
date Wed, 15 Aug 2012 22:39:18 +0200
parents e7cfe3587ea4
children 9724f8f8850b
files hgext/largefiles/lfutil.py hgext/largefiles/remotestore.py hgext/mq.py hgext/record.py hgext/schemes.py hgext/zeroconf/Zeroconf.py mercurial/bookmarks.py mercurial/commands.py mercurial/commandserver.py mercurial/config.py mercurial/context.py mercurial/match.py mercurial/obsolete.py mercurial/phases.py mercurial/pure/parsers.py mercurial/util.py
diffstat 16 files changed, 32 insertions(+), 28 deletions(-) [+]
line wrap: on
line diff
--- a/hgext/largefiles/lfutil.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/hgext/largefiles/lfutil.py	Wed Aug 15 22:39:18 2012 +0200
@@ -296,8 +296,8 @@
     '''Return the repo-relative path to the standin for the specified big
     file.'''
     # Notes:
-    # 1) Most callers want an absolute path, but _createstandin() needs
-    #    it repo-relative so lfadd() can pass it to repoadd().  So leave
+    # 1) Some callers want an absolute path, but for instance addlargefiles
+    #    needs it repo-relative so it can be passed to repoadd().  So leave
     #    it up to the caller to use repo.wjoin() to get an absolute path.
     # 2) Join with '/' because that's what dirstate always uses, even on
     #    Windows. Change existing separator to '/' first in case we are
--- a/hgext/largefiles/remotestore.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/hgext/largefiles/remotestore.py	Wed Aug 15 22:39:18 2012 +0200
@@ -4,7 +4,7 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
-'''remote largefile store; the base class for servestore'''
+'''remote largefile store; the base class for wirestore'''
 
 import urllib2
 
--- a/hgext/mq.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/hgext/mq.py	Wed Aug 15 22:39:18 2012 +0200
@@ -1522,7 +1522,7 @@
             #
             # this should really read:
             #   mm, dd, aa = repo.status(top, patchparent)[:3]
-            # but we do it backwards to take advantage of manifest/chlog
+            # but we do it backwards to take advantage of manifest/changelog
             # caching against the next repo.status call
             mm, aa, dd = repo.status(patchparent, top)[:3]
             changes = repo.changelog.read(top)
--- a/hgext/record.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/hgext/record.py	Wed Aug 15 22:39:18 2012 +0200
@@ -33,7 +33,7 @@
     - ('file',    [header_lines + fromfile + tofile])
     - ('context', [context_lines])
     - ('hunk',    [hunk_lines])
-    - ('range',   (-start,len, +start,len, diffp))
+    - ('range',   (-start,len, +start,len, proc))
     """
     lr = patch.linereader(fp)
 
--- a/hgext/schemes.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/hgext/schemes.py	Wed Aug 15 22:39:18 2012 +0200
@@ -61,7 +61,7 @@
         return '<ShortRepository: %s>' % self.scheme
 
     def instance(self, ui, url, create):
-        # Should this use urlmod.url(), or is manual parsing better?
+        # Should this use the util.url class, or is manual parsing better?
         url = url.split('://', 1)[1]
         parts = url.split('/', self.parts)
         if len(parts) > self.parts:
--- a/hgext/zeroconf/Zeroconf.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/hgext/zeroconf/Zeroconf.py	Wed Aug 15 22:39:18 2012 +0200
@@ -114,7 +114,7 @@
 _FLAGS_QR_QUERY = 0x0000 # query
 _FLAGS_QR_RESPONSE = 0x8000 # response
 
-_FLAGS_AA = 0x0400 # Authorative answer
+_FLAGS_AA = 0x0400 # Authoritative answer
 _FLAGS_TC = 0x0200 # Truncated
 _FLAGS_RD = 0x0100 # Recursion desired
 _FLAGS_RA = 0x8000 # Recursion available
@@ -650,7 +650,7 @@
 			if now == 0 or not record.isExpired(now):
 				self.answers.append((record, now))
 
-	def addAuthorativeAnswer(self, record):
+	def addAuthoritativeAnswer(self, record):
 		"""Adds an authoritative answer"""
 		self.authorities.append(record)
 
@@ -1433,7 +1433,7 @@
 			out = DNSOutgoing(_FLAGS_QR_QUERY | _FLAGS_AA)
 			self.debug = out
 			out.addQuestion(DNSQuestion(info.type, _TYPE_PTR, _CLASS_IN))
-			out.addAuthorativeAnswer(DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, _DNS_TTL, info.name))
+			out.addAuthoritativeAnswer(DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, _DNS_TTL, info.name))
 			self.send(out)
 			i += 1
 			nextTime += _CHECK_TIME
--- a/mercurial/bookmarks.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/bookmarks.py	Wed Aug 15 22:39:18 2012 +0200
@@ -58,7 +58,7 @@
             raise
         return None
     try:
-        # No readline() in posixfile_nt, reading everything is cheap
+        # No readline() in osutil.posixfile, reading everything is cheap
         mark = encoding.tolocal((file.readlines() or [''])[0])
         if mark == '' or mark not in repo._bookmarks:
             mark = None
--- a/mercurial/commands.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/commands.py	Wed Aug 15 22:39:18 2012 +0200
@@ -1352,20 +1352,20 @@
         # printed anyway.
         #
         # Par Msg Comment
-        # NN   y  additional topo root
+        # N N  y  additional topo root
         #
-        # BN   y  additional branch root
-        # CN   y  additional topo head
-        # HN   n  usual case
+        # B N  y  additional branch root
+        # C N  y  additional topo head
+        # H N  n  usual case
         #
-        # BB   y  weird additional branch root
-        # CB   y  branch merge
-        # HB   n  merge with named branch
+        # B B  y  weird additional branch root
+        # C B  y  branch merge
+        # H B  n  merge with named branch
         #
-        # CC   y  additional head from merge
-        # CH   n  merge with a head
+        # C C  y  additional head from merge
+        # C H  n  merge with a head
         #
-        # HH   n  head merge: head count decreases
+        # H H  n  head merge: head count decreases
 
     if not opts.get('close_branch'):
         for r in parents:
--- a/mercurial/commandserver.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/commandserver.py	Wed Aug 15 22:39:18 2012 +0200
@@ -137,7 +137,7 @@
         if logpath:
             global logfile
             if logpath == '-':
-                # write log on a special 'd'ebug channel
+                # write log on a special 'd' (debug) channel
                 logfile = channeledoutput(sys.stdout, sys.stdout, 'd')
             else:
                 logfile = open(logpath, 'a')
--- a/mercurial/config.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/config.py	Wed Aug 15 22:39:18 2012 +0200
@@ -67,7 +67,7 @@
         return self._data.get(section, {}).get(item, default)
 
     def backup(self, section, item):
-        """return a tuple allowing restore to reinstall a previous valuesi
+        """return a tuple allowing restore to reinstall previous values
 
         The main reason we need it is because it handle the "no data" case.
         """
--- a/mercurial/context.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/context.py	Wed Aug 15 22:39:18 2012 +0200
@@ -1167,7 +1167,7 @@
 
         returns True if different than fctx.
         """
-        # fctx should be a filectx (not a wfctx)
+        # fctx should be a filectx (not a workingfilectx)
         # invert comparison to reuse the same code path
         return fctx.cmp(self)
 
--- a/mercurial/match.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/match.py	Wed Aug 15 22:39:18 2012 +0200
@@ -49,7 +49,7 @@
         a pattern is one of:
         'glob:<glob>' - a glob relative to cwd
         're:<regexp>' - a regular expression
-        'path:<path>' - a path relative to canonroot
+        'path:<path>' - a path relative to repository root
         'relglob:<glob>' - an unrooted glob (*.c matches C files in all dirs)
         'relpath:<path>' - a path relative to cwd
         'relre:<regexp>' - a regexp that needn't match the start of a name
--- a/mercurial/obsolete.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/obsolete.py	Wed Aug 15 22:39:18 2012 +0200
@@ -318,7 +318,7 @@
 def anysuccessors(obsstore, node):
     """Yield every successor of <node>
 
-    This this a linear yield unsuitable to detect splitted changeset."""
+    This is a linear yield unsuitable to detect split changesets."""
     remaining = set([node])
     seen = set(remaining)
     while remaining:
--- a/mercurial/phases.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/phases.py	Wed Aug 15 22:39:18 2012 +0200
@@ -363,7 +363,7 @@
     """compute new head of a subset minus another
 
     * `heads`: define the first subset
-    * `roots`: define the second we substract to the first"""
+    * `roots`: define the second we subtract from the first"""
     revset = repo.set('heads((%ln + parents(%ln)) - (%ln::%ln))',
                       heads, roots, roots, heads)
     return [c.node() for c in revset]
--- a/mercurial/pure/parsers.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/pure/parsers.py	Wed Aug 15 22:39:18 2012 +0200
@@ -70,7 +70,7 @@
 
 def parse_dirstate(dmap, copymap, st):
     parents = [st[:20], st[20: 40]]
-    # deref fields so they will be local in loop
+    # dereference fields so they will be local in loop
     format = ">cllll"
     e_size = struct.calcsize(format)
     pos1 = 40
--- a/mercurial/util.py	Wed Aug 15 22:38:42 2012 +0200
+++ b/mercurial/util.py	Wed Aug 15 22:39:18 2012 +0200
@@ -1477,7 +1477,11 @@
                  for a in _hexdig for b in _hexdig)
 
 def _urlunquote(s):
-    """unquote('abc%20def') -> 'abc def'."""
+    """Decode HTTP/HTML % encoding.
+
+    >>> _urlunquote('abc%20def')
+    'abc def'
+    """
     res = s.split('%')
     # fastpath
     if len(res) == 1: