From 57dc2dec86f59127138dd7c5ad62cbdd9623404d Mon Sep 17 00:00:00 2001 From: anmol thapar Date: Wed, 13 Nov 2024 10:17:15 +0000 Subject: [PATCH] fix: add docstrings for parital_query_graph and tmp methods in PoppunkFileStore --- beebop/filestore.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/beebop/filestore.py b/beebop/filestore.py index 6c06e6d8..117d7183 100644 --- a/beebop/filestore.py +++ b/beebop/filestore.py @@ -119,6 +119,10 @@ def output_network(self, p_hash) -> str: return str(PurePath(self.output(p_hash), "network")) def parital_query_graph(self, p_hash) -> str: + """ + :param p_hash: [project hash] + :return str: [path to partial query graph] + """ return str(PurePath(self.output(p_hash), f"{p_hash}_query.subset")) def include_files(self, p_hash, cluster) -> str: @@ -225,6 +229,10 @@ def network_mapping(self, p_hash) -> str: 'cluster_component_dict.pickle')) def tmp(self, p_hash) -> str: + """ + :param p_hash: [project hash] + :return str: [path to tmp folder] + """ tmp_path = PurePath(self.output(p_hash), "tmp") os.makedirs(tmp_path, exist_ok=True) return str(tmp_path)