Mercurial > hg-stable
changeset 19911:1c58e368fbfd
shelve: some docstring cleanups
author | Augie Fackler <raf@durin42.com> |
---|---|
date | Wed, 16 Oct 2013 10:36:58 -0400 |
parents | 601944f41257 |
children | 1989111687a3 |
files | hgext/shelve.py |
diffstat | 1 files changed, 10 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/shelve.py Mon Oct 14 00:25:29 2013 -0400 +++ b/hgext/shelve.py Wed Oct 16 10:36:58 2013 -0400 @@ -77,10 +77,11 @@ self.name) class shelvedstate(object): - """Handle persistences during unshelving operation. + """Handle persistence during unshelving operations. Handles saving and restoring a shelved state. Ensures that different - versions of a shelved state are possible and handles them appropriate""" + versions of a shelved state are possible and handles them appropriately. + """ _version = 1 _filename = 'shelvedstate' @@ -120,7 +121,7 @@ util.unlinkpath(repo.join(cls._filename), ignoremissing=True) def createcmd(ui, repo, pats, opts): - """subcommand that create a new shelve""" + """subcommand that creates a new shelve""" def publicancestors(ctx): """Compute the heads of the public ancestors of a commit. @@ -251,7 +252,7 @@ lockmod.release(lock, wlock) def cleanupcmd(ui, repo): - """subcommand that delete all shelves""" + """subcommand that deletes all shelves""" wlock = None try: @@ -264,7 +265,7 @@ lockmod.release(wlock) def deletecmd(ui, repo, pats): - """subcommand that delete a specific shelve""" + """subcommand that deletes a specific shelve""" if not pats: raise util.Abort(_('no shelved changes specified!')) wlock = None @@ -282,7 +283,7 @@ lockmod.release(wlock) def listshelves(repo): - """return all shelves in repo as list of (time, filename)""" + """return all shelves in repo as list of (time, filename)""" try: names = repo.vfs.readdir('shelved') except OSError, err: @@ -299,7 +300,7 @@ return sorted(info, reverse=True) def listcmd(ui, repo, pats, opts): - """subcommand that display the list of shelve""" + """subcommand that displays the list of shelves""" pats = set(pats) width = 80 if not ui.plain(): @@ -347,7 +348,7 @@ fp.close() def readshelvedfiles(repo, basename): - """return the list of file touched in a shelve""" + """return the list of files touched in a shelve""" fp = shelvedfile(repo, basename, 'files').opener() return fp.read().split('\0') @@ -389,7 +390,7 @@ lockmod.release(lock, wlock) def unshelvecleanup(ui, repo, name, opts): - """remove related file after an unshelve""" + """remove related files after an unshelve""" if not opts['keep']: for filetype in 'hg files patch'.split(): shelvedfile(repo, name, filetype).unlink()