Mercurial Mercurial > mercurial / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
turn some comments back into module docstrings
authorMartin Geisler <mg@lazybytes.net>
Sun, 26 Apr 2009 01:24:49 +0200
changeset 8227 0a9542703300
parent 8226 8b2cd04a6e97
child 8228 eee2319c5895
turn some comments back into module docstrings
mercurial/bundlerepo.py file | annotate | diff | comparison | revisions
mercurial/error.py file | annotate | diff | comparison | revisions
mercurial/revlog.py file | annotate | diff | comparison | revisions
mercurial/util.py file | annotate | diff | comparison | revisions
mercurial/win32.py file | annotate | diff | comparison | revisions 
--- a/mercurial/bundlerepo.py	Sun Apr 26 01:13:08 2009 +0200
+++ b/mercurial/bundlerepo.py	Sun Apr 26 01:24:49 2009 +0200
@@ -1,13 +1,16 @@
 # bundlerepo.py - repository class for viewing uncompressed bundles
 #
-# This provides a read-only repository interface to bundles as if
-# they were part of the actual repository.
-#
 # Copyright 2006, 2007 Benoit Boissinot <bboissin@gmail.com>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
+"""Repository class for viewing uncompressed bundles.
+
+This provides a read-only repository interface to bundles as if they
+were part of the actual repository.
+"""
+
 from node import nullid
 from i18n import _
 import changegroup, util, os, struct, bz2, zlib, tempfile, shutil, mdiff
--- a/mercurial/error.py	Sun Apr 26 01:13:08 2009 +0200
+++ b/mercurial/error.py	Sun Apr 26 01:24:49 2009 +0200
@@ -1,12 +1,16 @@
 # error.py - Mercurial exceptions
 #
-# This allows us to catch exceptions at higher levels without forcing imports
-#
 # Copyright 2005-2008 Matt Mackall <mpm@selenic.com>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
+"""Mercurial exceptions.
+
+This allows us to catch exceptions at higher levels without forcing
+imports.
+"""
+
 # Do not import anything here, please
 
 class RevlogError(Exception):
--- a/mercurial/revlog.py	Sun Apr 26 01:13:08 2009 +0200
+++ b/mercurial/revlog.py	Sun Apr 26 01:24:49 2009 +0200
@@ -1,13 +1,16 @@
 # revlog.py - storage back-end for mercurial
 #
-# This provides efficient delta storage with O(1) retrieve and append
-# and O(changes) merge between branches
-#
 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
 
+"""Storage back-end for Mercurial.
+
+This provides efficient delta storage with O(1) retrieve and append
+and O(changes) merge between branches.
+"""
+
 # import stuff from node for others to import from revlog
 from node import bin, hex, nullid, nullrev, short #@UnusedImport
 from i18n import _
--- a/mercurial/util.py	Sun Apr 26 01:13:08 2009 +0200
+++ b/mercurial/util.py	Sun Apr 26 01:24:49 2009 +0200
@@ -6,9 +6,12 @@
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
-#
-# This contains helper routines that are independent of the SCM core and hide
-# platform-specific details from the core.
+
+"""Mercurial utility functions and platform specfic implementations.
+
+This contains helper routines that are independent of the SCM core and
+hide platform-specific details from the core.
+"""
 
 from i18n import _
 import cStringIO, errno, re, shutil, sys, tempfile, traceback, error
--- a/mercurial/win32.py	Sun Apr 26 01:13:08 2009 +0200
+++ b/mercurial/win32.py	Sun Apr 26 01:24:49 2009 +0200
@@ -4,11 +4,14 @@
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2, incorporated herein by reference.
-#
-# Mark Hammond's win32all package allows better functionality on
-# Windows.  this module overrides definitions in util.py.  if not
-# available, import of this module will fail, and generic code will be
-# used.
+
+"""Utility functions that use win32 API.
+
+Mark Hammond's win32all package allows better functionality on
+Windows. This module overrides definitions in util.py. If not
+available, import of this module will fail, and generic code will be
+used.
+"""
 
 import win32api
mercurial