From 92818c444e77415d64107fa00f84ee39d72425dc Mon Sep 17 00:00:00 2001 From: Eric Torres Date: Mon, 25 Mar 2019 14:41:42 -0700 Subject: [PATCH] Docstring updates --- packaging_scripts/pkgfiles.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/packaging_scripts/pkgfiles.py b/packaging_scripts/pkgfiles.py index dd11677..4e53ae8 100644 --- a/packaging_scripts/pkgfiles.py +++ b/packaging_scripts/pkgfiles.py @@ -27,8 +27,7 @@ def get(query=None, *, directory=None, signatures_only=False): :type directory: str or path-like object :param signatures_only: include only signature files :type signatures_only: bool - :returns: paths of package files - :rtype: list + :yields: paths of package files """ path = Path.cwd() if directory is None else Path(directory) filequery = f"*{query}*" if query is not None else "*" @@ -40,7 +39,7 @@ def get(query=None, *, directory=None, signatures_only=False): def add(pkgfile, cachedir): - """Add package file to the repository directory. + """Add package file to the repository cache directory. :param pkg: path of package to add :type pkg: path-like object @@ -62,7 +61,7 @@ def delete(pkg): def _filter_by_regex(query, regex_expression, path): - """Filter package files only. + """Filter by regular expression. :param query: names of package files to search for :type query: str