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

[PATCH v3 20/21] git-p4: move inline comments to line above

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

PEP8 recommends that all inline comments should be separated from code by two spaces, in the "Inline Comments" section:

https://www.python.org/dev/peps/pep-0008/#inline-comments

However, because all instances of these inline comments extended to an excessive line length, they have been moved onto a seprate line.

Signed-off-by: Joel Holdsworth <jholdsworth@nvidia.com>
---
 git-p4.py | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/git-p4.py b/git-p4.py
index accb1b0f1d..4d291d0870 100755
--- a/git-p4.py
+++ b/git-p4.py
@@ -2037,7 +2037,9 @@ def get_diff_description(self, editedFiles, filesToAdd, symlinks):
                     for line in f.readlines():
                         newdiff += "+" + line
                 except UnicodeDecodeError:
-                    pass # Found non-text data and skip, since diff description should only include text
+                    # Found non-text data and skip, since diff description
+                    # should only include text
+                    pass
                 f.close()
 
         return (diff + newdiff).replace('\r\n', '\n')
@@ -3033,7 +3035,8 @@ def streamOneP4File(self, file, contents):
             if 'fileSize' in self.stream_file:
                 size = int(self.stream_file['fileSize'])
             else:
-                size = 0 # deleted files don't get a fileSize apparently
+                # Deleted files don't get a fileSize apparently
+                size = 0
             sys.stdout.write('\r%s --> %s (%s)\n' % (
                 file_path, relPath, format_size_human_readable(size)))
             sys.stdout.flush()
@@ -4291,7 +4294,8 @@ def renameBranch(self, branch_name):
         for i in range(0, 1000):
             backup_branch_name = "{0}.{1}".format(branch_name, i)
             if not gitBranchExists(backup_branch_name):
-                gitUpdateRef(backup_branch_name, branch_name) # copy ref to backup
+                # Copy ref to backup
+                gitUpdateRef(backup_branch_name, branch_name)
                 gitDeleteRef(branch_name)
                 found = True
                 print("renamed old unshelve branch to {0}".format(backup_branch_name))
-- 
2.34.1
Previous: Joel HoldsworthNext: Joel Holdsworth
Message 21 of 29 in “git-p4: Various code tidy-ups”
  1. 00/21 git-p4: Various code tidy-upsJoel Holdsworth, Jan 16, 2022
  2. 02/21 git-p4: remove unneeded semicolons from statementsJoel Holdsworth, Jan 16, 2022
  3. Junio C HamanoJan 17, 2022
  4. 01/21 git-p4: add blank lines between functions and class definitionsJoel Holdsworth, Jan 16, 2022
  5. 03/21 git-p4: indent with 4-spacesJoel Holdsworth, Jan 16, 2022
  6. 04/21 git-p4: improve consistency of docstring formattingJoel Holdsworth, Jan 16, 2022
  7. 05/21 git-p4: convert descriptive class and function comments into docstringsJoel Holdsworth, Jan 16, 2022
  8. 06/21 git-p4: remove commented codeJoel Holdsworth, Jan 16, 2022
  9. 07/21 git-p4: sort and de-duplcate pylint disable listJoel Holdsworth, Jan 16, 2022
  10. 08/21 git-p4: remove padding from lists, tuples and function argumentsJoel Holdsworth, Jan 16, 2022
  11. 09/21 git-p4: remove spaces around default argumentsJoel Holdsworth, Jan 16, 2022
  12. 10/21 git-p4: removed brackets when assigning multiple return valuesJoel Holdsworth, Jan 16, 2022
  13. 11/21 git-p4: place a single space after every commaJoel Holdsworth, Jan 16, 2022
  14. 12/21 git-p4: remove extraneous spaces before function argumentsJoel Holdsworth, Jan 16, 2022
  15. 13/21 git-p4: remove redundant backslash-continuations inside bracketsJoel Holdsworth, Jan 16, 2022
  16. 14/21 git-p4: remove spaces between dictionary keys and colonsJoel Holdsworth, Jan 16, 2022
  17. 15/21 git-p4: ensure every comment has a single #Joel Holdsworth, Jan 16, 2022
  18. 16/21 git-p4: ensure there is a single space around all operatorsJoel Holdsworth, Jan 16, 2022
  19. 17/21 git-p4: normalize indentation of lines in conditionalsJoel Holdsworth, Jan 16, 2022
  20. 18/21 git-p4: compare to singletons with "is" and "is not"Joel Holdsworth, Jan 16, 2022
  21. 20/21 git-p4: move inline comments to line aboveJoel Holdsworth, Jan 16, 2022
  22. 21/21 git-p4: seperate multiple statements onto seperate linesJoel Holdsworth, Jan 16, 2022
  23. 19/21 git-p4: only seperate code blocks by a single empty lineJoel Holdsworth, Jan 16, 2022
  24. Junio C HamanoJan 17, 2022
  25. Joel HoldsworthFeb 3, 2022
  26. Junio C HamanoFeb 3, 2022
  27. Joel HoldsworthFeb 4, 2022
  28. Junio C HamanoFeb 4, 2022
  29. Junio C HamanoJan 17, 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.