Skip to content

Commit f689d0c

Browse files
committed
Update docstring #845
Signed-off-by: Jono Yang <jyang@nexb.com>
1 parent 5a54540 commit f689d0c

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

minecode_pipelines/pipelines/__init__.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,14 @@ def commit_and_push_packageurls(
157157
last_checkpoint_call,
158158
logger,
159159
):
160+
"""
161+
Given a list of `current_working_repos`, commit and push changes to each repo with the commit message returned from `commit_msg_func`.
162+
163+
If `checkpoint_on_commit` is True and `checkpoint_func` exists, then we execute `checkpoint_func`.
164+
165+
If `checkpoint_on_commit` is False, then we determine if it is time to call `checkpoint_func` or not.
166+
"""
167+
160168
if logger:
161169
logger("Trying to commit PackageURLs.")
162170

@@ -181,6 +189,11 @@ def commit_and_push_packageurls(
181189
def get_repo_checkout_from_data_cluster(
182190
data_cluster, purl, checked_out_repos, working_path, logger, datafile_name=None
183191
):
192+
"""
193+
Return a `repo_checkout` and `datafile_path` for a given `purl`, `data_cluster`, and `working_path`.
194+
195+
Add `repo_checkout` to `checked_out_repos`.
196+
"""
184197
repo, datafile_path = data_cluster.get_datafile_repo_and_path(
185198
purl=purl, datafile_name=datafile_name
186199
)

0 commit comments

Comments
 (0)