Mercurial > public > mercurial-scm > hg-stable
diff hgext/largefiles/lfcommands.py @ 15252:6e809bb4f969
largefiles: improve comments, internal docstrings
- fix some ungrammatical/unclear/incorrect comments/docstrings
- rewrite some really unclear comments/docstrings
- make formatting/style more consistent with the rest of Mercurial
(lowercase without period unless it's really multiple sentences)
- wrap to 75 columns
- always say "largefile(s)", not "lfile(s)" (or "big files")
- one space between sentences, not two
| author | Greg Ward <greg@gerg.ca> |
|---|---|
| date | Wed, 12 Oct 2011 20:59:27 -0400 |
| parents | 697289c5d415 |
| children | 67d010779907 |
line wrap: on
line diff
--- a/hgext/largefiles/lfcommands.py Thu Oct 13 15:15:32 2011 +0200 +++ b/hgext/largefiles/lfcommands.py Wed Oct 12 20:59:27 2011 -0400 @@ -6,7 +6,7 @@ # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. -'''High-level command functions: lfadd() et. al, plus the cmdtable.''' +'''High-level command function for lfconvert, plus the cmdtable.''' import os import shutil @@ -316,11 +316,9 @@ revmap[ctx.node()] = rdst.changelog.tip() def _islfile(file, ctx, matcher, size): - ''' - A file is a lfile if it matches a pattern or is over - the given size. - ''' - # Never store hgtags or hgignore as lfiles + '''Return true if file should be considered a largefile, i.e. + matcher matches it or it is larger than size.''' + # never store special .hg* files as largefiles if file == '.hgtags' or file == '.hgignore' or file == '.hgsigs': return False if matcher and matcher(file):