Clean up bookmark comments implementation and document

CHANGELOG

@@ -1,5 +1,6 @@
 v0.6 (unreleased):
 
+- Support simple comments in the bookmarks file. (#51)
 - Add an integrated pytest testing suite, runnable with `--selftest`.
 - Refactor internals, remove deprecated options, and drop support for
   end-of-life Python versions.

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2011-2018 Ben Kurtovic <ben.kurtovic@gmail.com>
+Copyright (C) 2011-2019 Ben Kurtovic <ben.kurtovic@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

gitup/update.py

@@ -259,15 +259,14 @@ def _dispatch(base_path, callback, args):
     except exc.NoSuchPathError:
         if is_comment(base):
             comment = get_comment(base)
-            if len(comment) > 0:
+            if comment:
                 print(CYAN + BOLD + comment)
             return
-        else:
-            paths = glob(base)
-            if not paths:
-                print(ERROR, BOLD + base, "doesn't exist!")
-                return
-            valid = _collect(paths, max_depth)
+        paths = glob(base)
+        if not paths:
+            print(ERROR, BOLD + base, "doesn't exist!")
+            return
+        valid = _collect(paths, max_depth)
     except exc.InvalidGitRepositoryError:
         if not os.path.isdir(base) or args.max_depth == 0:
             print(ERROR, BOLD + base, "isn't a repository!")
@@ -285,24 +284,11 @@ def _dispatch(base_path, callback, args):
 
 def is_comment(path):
     """Does the line start with a # symbol?"""
-    cs = path.lstrip()
-    if cs[0] == "#":
-        return True
-    return False
+    return path.lstrip().startswith("#")
 
 def get_comment(path):
     """Return the string minus the comment symbol."""
-    rs = ""
-    cs = path.lstrip()
-    if len(cs) > 0:
-        for j in range(0, len(cs)):
-            c = cs[j]
-            if c == "#" and len(rs) == 0:
-                continue
-            rs = rs + c
-        if len(rs) > 0:
-            rs = rs.lstrip()
-    return rs
+    return path.lstrip().lstrip("#").strip()
 
 def update_bookmarks(bookmarks, args):
     """Loop through and update all bookmarks."""