Mercurial > public > mercurial-scm > hg-stable
diff mercurial/crecord.py @ 43807:be8552f25cab
cleanup: fix docstring formatting
This is just removing the b'' prefix (except demandimportpy2), and making sure
it is triple quoted. I skipped the mapping.py module in zope because that's 3rd
party code.
Differential Revision: https://phab.mercurial-scm.org/D7539
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Sun, 01 Dec 2019 18:46:10 -0500 |
parents | 9f70512ae2cf |
children | ac54b8a2ebea |
line wrap: on
line diff
--- a/mercurial/crecord.py Wed Nov 13 20:42:13 2019 +0100 +++ b/mercurial/crecord.py Sun Dec 01 18:46:10 2019 -0500 @@ -102,7 +102,7 @@ raise NotImplementedError(b"method must be implemented by subclass") def allchildren(self): - b"Return a list of all of the direct children of this node" + """Return a list of all of the direct children of this node""" raise NotImplementedError(b"method must be implemented by subclass") def nextsibling(self): @@ -264,21 +264,23 @@ return None def firstchild(self): - b"return the first child of this item, if one exists. otherwise None." + """return the first child of this item, if one exists. otherwise + None.""" if len(self.hunks) > 0: return self.hunks[0] else: return None def lastchild(self): - b"return the last child of this item, if one exists. otherwise None." + """return the last child of this item, if one exists. otherwise + None.""" if len(self.hunks) > 0: return self.hunks[-1] else: return None def allchildren(self): - b"return a list of all of the direct children of this node" + """return a list of all of the direct children of this node""" return self.hunks def __getattr__(self, name): @@ -286,7 +288,7 @@ class uihunkline(patchnode): - b"represents a changed line in a hunk" + """represents a changed line in a hunk""" def __init__(self, linetext, hunk): self.linetext = linetext @@ -319,16 +321,18 @@ return None def parentitem(self): - b"return the parent to the current item" + """return the parent to the current item""" return self.hunk def firstchild(self): - b"return the first child of this item, if one exists. otherwise None." + """return the first child of this item, if one exists. otherwise + None.""" # hunk-lines don't have children return None def lastchild(self): - b"return the last child of this item, if one exists. otherwise None." + """return the last child of this item, if one exists. otherwise + None.""" # hunk-lines don't have children return None @@ -372,25 +376,27 @@ return None def parentitem(self): - b"return the parent to the current item" + """return the parent to the current item""" return self.header def firstchild(self): - b"return the first child of this item, if one exists. otherwise None." + """return the first child of this item, if one exists. otherwise + None.""" if len(self.changedlines) > 0: return self.changedlines[0] else: return None def lastchild(self): - b"return the last child of this item, if one exists. otherwise None." + """return the last child of this item, if one exists. otherwise + None.""" if len(self.changedlines) > 0: return self.changedlines[-1] else: return None def allchildren(self): - b"return a list of all of the direct children of this node" + """return a list of all of the direct children of this node""" return self.changedlines def countchanges(self): @@ -853,7 +859,7 @@ self.currentselecteditem = currentitem def updatescroll(self): - b"scroll the screen to fully show the currently-selected" + """scroll the screen to fully show the currently-selected""" selstart = self.selecteditemstartline selend = self.selecteditemendline @@ -871,7 +877,7 @@ self.scrolllines(selstart - padstartbuffered) def scrolllines(self, numlines): - b"scroll the screen up (down) by numlines when numlines >0 (<0)." + """scroll the screen up (down) by numlines when numlines >0 (<0).""" self.firstlineofpadtoprint += numlines if self.firstlineofpadtoprint < 0: self.firstlineofpadtoprint = 0 @@ -973,7 +979,7 @@ ) def toggleall(self): - b"toggle the applied flag of all items." + """toggle the applied flag of all items.""" if self.waslasttoggleallapplied: # then unapply them this time for item in self.headerlist: if item.applied: @@ -985,7 +991,8 @@ self.waslasttoggleallapplied = not self.waslasttoggleallapplied def toggleallbetween(self): - b"toggle applied on or off for all items in range [lastapplied,current]." + """toggle applied on or off for all items in range [lastapplied, + current]. """ if ( not self.lastapplieditem or self.currentselecteditem == self.lastapplieditem @@ -1026,7 +1033,8 @@ nextitem = nextitem.nextitem() def togglefolded(self, item=None, foldparent=False): - b"toggle folded flag of specified item (defaults to currently selected)" + """toggle folded flag of specified item (defaults to currently + selected)""" if item is None: item = self.currentselecteditem if foldparent or (isinstance(item, uiheader) and item.neverunfolded): @@ -1320,7 +1328,7 @@ def printhunklinesbefore( self, hunk, selected=False, towin=True, ignorefolding=False ): - b"includes start/end line indicator" + """includes start/end line indicator""" outstr = b"" # where hunk is in list of siblings hunkindex = hunk.header.hunks.index(hunk) @@ -1529,7 +1537,7 @@ return numlines def sigwinchhandler(self, n, frame): - b"handle window resizing" + """handle window resizing""" try: curses.endwin() self.xscreensize, self.yscreensize = scmutil.termsize(self.ui) @@ -1599,11 +1607,11 @@ return colorpair def initcolorpair(self, *args, **kwargs): - b"same as getcolorpair." + """same as getcolorpair.""" self.getcolorpair(*args, **kwargs) def helpwindow(self): - b"print a help window to the screen. exit after any keypress." + """print a help window to the screen. exit after any keypress.""" helptext = _( """ [press any key to return to the patch-display] @@ -1654,7 +1662,7 @@ pass def commitMessageWindow(self): - b"Create a temporary commit message editing window on the screen." + """Create a temporary commit message editing window on the screen.""" curses.raw() curses.def_prog_mode() @@ -1704,7 +1712,8 @@ self.recenterdisplayedarea() def confirmationwindow(self, windowtext): - b"display an informational window, then wait for and return a keypress." + """display an informational window, then wait for and return a + keypress.""" confirmwin = curses.newwin(self.yscreensize, 0, 0, 0) try: