Docstring fixes

This commit is contained in:
Steve Purcell 2014-10-22 17:25:13 +01:00
parent 9c5ea906b1
commit 711ddbeb29

View file

@ -152,8 +152,14 @@ function for access to this function")
(format "%d" (or (string-to-number (format-time-string "%H%M" time)) 0))))) (format "%d" (or (string-to-number (format-time-string "%H%M" time)) 0)))))
(defun pb/string-match-all (regex str &rest groups) (defun pb/string-match-all (regex str &rest groups)
"Find every match for `REGEX' within `STR', returning a list containing the full match string and match for groups `GROUPS'. "Find every match for `REGEX' within `STR'.
The return list is of the form ((FULL GROUP1 GROUP2 ...) ...) where FULL is the complete regexp match and GROUP1, GROUP2, ... are the regex groups specified by the `GROUPS' argument. If `GROUPS' is nil then FULL and GROUP1 will be identical." Return a list containing the full match string and match for
groups `GROUPS'. The return list is of the form
((FULL GROUP1 GROUP2 ...) ...)
where FULL is the complete regexp match and
GROUP1, GROUP2, ... are the regex groups specified by the
`GROUPS' argument. If `GROUPS' is nil then FULL and GROUP1 will
be identical."
(let (result (let (result
(pos 0) (pos 0)
(groups (or groups '(0)))) (groups (or groups '(0))))
@ -172,7 +178,7 @@ The return list is of the form ((FULL GROUP1 GROUP2 ...) ...) where FULL is the
(match-string-no-properties 1)))) (match-string-no-properties 1))))
(defun pb/valid-version-string (str) (defun pb/valid-version-string (str)
"Returns true if STR is a valid version, otherwise return nil." "Return true if STR is a valid version, otherwise return nil."
(ignore-errors (version-to-list str))) (ignore-errors (version-to-list str)))
(defun pb/find-tag-version-newest (regex &optional bound &rest additional-groups) (defun pb/find-tag-version-newest (regex &optional bound &rest additional-groups)