git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 15/21] git-p4: ensure every comment has a single #

From
Joel Holdsworth <jholdsworth@nvidia.com>
Date
Jan 13, 2022, 13:47 UTC
Message-ID
<20220113134728.23192-16-jholdsworth@nvidia.com>
In-Reply-To
<20220113134728.23192-1-jholdsworth@nvidia.com>

PEP8 recommends that every comment should begin with a single '#' character.

This guideline is described here: https://www.python.org/dev/peps/pep-0008/#comments

Signed-off-by: Joel Holdsworth <jholdsworth@nvidia.com>
---
 git-p4.py | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/git-p4.py b/git-p4.py
index f77a5ac000..5c2f2145d7 100755
--- a/git-p4.py
+++ b/git-p4.py
@@ -968,7 +968,7 @@ def branchExists(ref):
 def extractLogMessageFromGitCommit(commit):
     logMessage = ""
 
-    ## fixme: title is first line of commit, not 1st paragraph.
+    # fixme: title is first line of commit, not 1st paragraph.
     foundTitle = False
     for log in read_pipe_lines(["git", "cat-file", "commit", commit]):
         if not foundTitle:
@@ -3560,7 +3560,7 @@ def getBranchMapping(self):
                     continue
                 source = paths[0]
                 destination = paths[1]
-                ## HACK
+                # HACK
                 if p4PathStartsWith(source, self.depotPaths[0]) and p4PathStartsWith(destination, self.depotPaths[0]):
                     source = source[len(self.depotPaths[0]):-4]
                     destination = destination[len(self.depotPaths[0]):-4]
@@ -3718,7 +3718,7 @@ def importChanges(self, changes, origin_revision=0):
                 if self.detectBranches:
                     branches = self.splitFilesIntoBranches(description)
                     for branch in branches.keys():
-                        ## HACK  --hwn
+                        # HACK  --hwn
                         branchPrefix = self.depotPaths[0] + branch + "/"
                         self.branchPrefixes = [branchPrefix]
 
@@ -4108,7 +4108,7 @@ def run(self, args):
             self.getLabels()
 
         if self.detectBranches:
-            ## FIXME - what's a P4 projectName ?
+            # FIXME - what's a P4 projectName ?
             self.projectName = self.guessProjectName()
 
             if self.hasOrigin:
@@ -4121,7 +4121,7 @@ def run(self, args):
             for b in self.p4BranchesInGit:
                 if b != "master":
 
-                    ## FIXME
+                    # FIXME
                     b = b[len(self.projectName):]
                 self.createdBranches.add(b)
 
@@ -4226,7 +4226,7 @@ def __init__(self):
         self.cloneBare = False
 
     def defaultDestination(self, args):
-        ## TODO: use common prefix of args?
+        # TODO: use common prefix of args?
         depotPath = args[0]
         depotDir = re.sub("(@[^@]*)$", "", depotPath)
         depotDir = re.sub("(#[^#]*)$", "", depotDir)
-- 
2.34.1
Previous: Joel HoldsworthNext: Joel Holdsworth
Message 16 of 24 in “git-p4: Various code tidy-ups”
  1. 00/21 git-p4: Various code tidy-upsJoel Holdsworth, Jan 13, 2022
  2. 01/21 git-p4: add blank lines between functions and class definitionsJoel Holdsworth, Jan 13, 2022
  3. 02/21 git-p4: remove unneeded semicolons from statementsJoel Holdsworth, Jan 13, 2022
  4. 03/21 git-p4: indent with 4-spacesJoel Holdsworth, Jan 13, 2022
  5. 04/21 git-p4: improve consistency of docstring formattingJoel Holdsworth, Jan 13, 2022
  6. 05/21 git-p4: convert descriptive class and function comments into docstringsJoel Holdsworth, Jan 13, 2022
  7. 06/21 git-p4: remove commented codeJoel Holdsworth, Jan 13, 2022
  8. 07/21 git-p4: sort and de-duplcate pylint disable listJoel Holdsworth, Jan 13, 2022
  9. 10/21 git-p4: removed brackets when assigning multiple return valuesJoel Holdsworth, Jan 13, 2022
  10. 08/21 git-p4: remove padding from lists, tuples and function argumentsJoel Holdsworth, Jan 13, 2022
  11. 11/21 git-p4: place a single space after every commaJoel Holdsworth, Jan 13, 2022
  12. 09/21 git-p4: remove spaces around default argumentsJoel Holdsworth, Jan 13, 2022
  13. 12/21 git-p4: remove extraneous spaces before function argumentsJoel Holdsworth, Jan 13, 2022
  14. 13/21 git-p4: remove redundant backslash-continuations inside bracketsJoel Holdsworth, Jan 13, 2022
  15. 14/21 git-p4: remove spaces between dictionary keys and colonsJoel Holdsworth, Jan 13, 2022
  16. 15/21 git-p4: ensure every comment has a single #Joel Holdsworth, Jan 13, 2022
  17. 18/21 git-p4: compare to singletons with "is" and "is not"Joel Holdsworth, Jan 13, 2022
  18. 16/21 git-p4: ensure there is a single space around all operatorsJoel Holdsworth, Jan 13, 2022
  19. 21/21 git-p4: seperate multiple statements onto seperate linesJoel Holdsworth, Jan 13, 2022
  20. 17/21 git-p4: normalize indentation of lines in conditionalsJoel Holdsworth, Jan 13, 2022
  21. 19/21 git-p4: only seperate code blocks by a single empty lineJoel Holdsworth, Jan 13, 2022
  22. 20/21 git-p4: move inline comments to line aboveJoel Holdsworth, Jan 13, 2022
  23. Junio C HamanoJan 13, 2022
  24. Joel HoldsworthJan 14, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.