@@ -1023,8 +1023,8 @@ def move(
1023
1023
was_dry_run = kwargs .pop ("dry_run" , kwargs .pop ("n" , None ))
1024
1024
kwargs ["dry_run" ] = True
1025
1025
1026
- # First execute rename in dryrun so the command tells us what it actually does.
1027
- # (for later output)
1026
+ # First execute rename in dryrun so the command tells us what it actually does
1027
+ # (for later output).
1028
1028
out = []
1029
1029
mvlines = self .repo .git .mv (args , paths , ** kwargs ).splitlines ()
1030
1030
@@ -1186,7 +1186,7 @@ def checkout(
1186
1186
def handle_stderr (proc : "Popen[bytes]" , iter_checked_out_files : Iterable [PathLike ]) -> None :
1187
1187
stderr_IO = proc .stderr
1188
1188
if not stderr_IO :
1189
- return None # return early if stderr empty
1189
+ return None # Return early if stderr empty.
1190
1190
else :
1191
1191
stderr_bytes = stderr_IO .read ()
1192
1192
# line contents:
@@ -1252,9 +1252,9 @@ def handle_stderr(proc: "Popen[bytes]", iter_checked_out_files: Iterable[PathLik
1252
1252
if isinstance (paths , str ):
1253
1253
paths = [paths ]
1254
1254
1255
- # make sure we have our entries loaded before we start checkout_index
1255
+ # Make sure we have our entries loaded before we start checkout_index,
1256
1256
# which will hold a lock on it. We try to get the lock as well during
1257
- # our entries initialization
1257
+ # our entries initialization.
1258
1258
self .entries
1259
1259
1260
1260
args .append ("--stdin" )
@@ -1267,7 +1267,7 @@ def handle_stderr(proc: "Popen[bytes]", iter_checked_out_files: Iterable[PathLik
1267
1267
1268
1268
for path in paths :
1269
1269
co_path = to_native_path_linux (self ._to_relative_path (path ))
1270
- # if the item is not in the index, it could be a directory
1270
+ # If the item is not in the index, it could be a directory.
1271
1271
path_is_directory = False
1272
1272
1273
1273
try :
@@ -1347,8 +1347,8 @@ def reset(
1347
1347
If you want git-reset like behaviour, use *HEAD.reset* instead.
1348
1348
1349
1349
:return: self"""
1350
- # what we actually want to do is to merge the tree into our existing
1351
- # index, which is what git-read-tree does
1350
+ # What we actually want to do is to merge the tree into our existing
1351
+ # index, which is what git-read-tree does.
1352
1352
new_inst = type (self ).from_tree (self .repo , commit )
1353
1353
if not paths :
1354
1354
self .entries = new_inst .entries
@@ -1360,7 +1360,7 @@ def reset(
1360
1360
key = entry_key (path , 0 )
1361
1361
self .entries [key ] = nie [key ]
1362
1362
except KeyError :
1363
- # if key is not in theirs, it musn't be in ours
1363
+ # If key is not in theirs, it musn't be in ours.
1364
1364
try :
1365
1365
del self .entries [key ]
1366
1366
except KeyError :
@@ -1391,7 +1391,7 @@ def diff(
1391
1391
) -> git_diff .DiffIndex :
1392
1392
"""Diff this index against the working copy or a Tree or Commit object.
1393
1393
1394
- For a documentation of the parameters and return values, see
1394
+ For documentation of the parameters and return values, see
1395
1395
:meth:`Diffable.diff <git.diff.Diffable.diff>`.
1396
1396
1397
1397
:note:
@@ -1413,7 +1413,7 @@ def diff(
1413
1413
other = self .repo .rev_parse (other )
1414
1414
# END object conversion
1415
1415
1416
- if isinstance (other , Object ): # for Tree or Commit
1416
+ if isinstance (other , Object ): # For Tree or Commit.
1417
1417
# Invert the existing R flag.
1418
1418
cur_val = kwargs .get ("R" , False )
1419
1419
kwargs ["R" ] = not cur_val
0 commit comments