From 24c55c68b782a140bfe36bccdd4696b3de6071cb Mon Sep 17 00:00:00 2001 From: Philipp Horstenkamp Date: Sun, 12 Nov 2023 13:58:00 +0100 Subject: [PATCH] Removed docstring ruins. (#367) --- .../utils/mongo/company_mongo_service.py | 2 +- .../utils/networkx/network_2d.py | 16 ++++++++-------- .../utils/networkx/network_3d.py | 2 +- .../utils/networkx/networkx_data.py | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/aki_prj23_transparenzregister/utils/mongo/company_mongo_service.py b/src/aki_prj23_transparenzregister/utils/mongo/company_mongo_service.py index 51c1309..b79b164 100644 --- a/src/aki_prj23_transparenzregister/utils/mongo/company_mongo_service.py +++ b/src/aki_prj23_transparenzregister/utils/mongo/company_mongo_service.py @@ -143,7 +143,7 @@ class CompanyMongoService: company (Company): _description_ Returns: - _type_: _description_ + _description_ """ with self.lock: return self.collection.insert_one(company.to_dict()) diff --git a/src/aki_prj23_transparenzregister/utils/networkx/network_2d.py b/src/aki_prj23_transparenzregister/utils/networkx/network_2d.py index ada0528..0f0843a 100644 --- a/src/aki_prj23_transparenzregister/utils/networkx/network_2d.py +++ b/src/aki_prj23_transparenzregister/utils/networkx/network_2d.py @@ -18,17 +18,17 @@ def create_2d_graph( # noqa PLR0913 """This Method creates a 2d Network in Plotly with a Scatter Graph and retuns it. Args: - graph (_type_): NetworkX Graph. - nodes (_type_): List of Nodes - edges (_type_): List of Edges - metrics (_type_): DataFrame with the MEtrics - metric (_type_): Selected Metric + graph: NetworkX Graph. + nodes: List of Nodes + edges: List of Edges + metrics: DataFrame with the Metrics + metric: Selected Metric edge_annotation: Enables the Description of Edges edge_thickness: Int Value of the Edge thickness layout: String which defines the Graph Layout Returns: - _type_: Plotly Figure + Plotly Figure """ # Set 2D Layout pos = nx.spring_layout(graph) @@ -87,7 +87,7 @@ def create_2d_graph( # noqa PLR0913 hoverinfo="none", mode="lines", ) - # Add the Edgedescriptiontext to the scatter plot according to its Position. + # Add the Edge description text to the scatter plot according to its Position. edge_weights_trace = go.Scatter( x=edge_weight_x, y=edge_weight_y, @@ -144,7 +144,7 @@ def create_2d_graph( # noqa PLR0913 node_trace.marker.color = colors node_trace.text = node_names - # Highlight the Node Size in regards to the selected Metric. + # Highlight the Node Size with regard to the selected Metric. if metric != "None": node_trace.marker.size = list(np.sqrt(metrics[metric]) * 200) diff --git a/src/aki_prj23_transparenzregister/utils/networkx/network_3d.py b/src/aki_prj23_transparenzregister/utils/networkx/network_3d.py index ce984a6..f86962f 100644 --- a/src/aki_prj23_transparenzregister/utils/networkx/network_3d.py +++ b/src/aki_prj23_transparenzregister/utils/networkx/network_3d.py @@ -25,7 +25,7 @@ def create_3d_graph( # noqa : PLR0913 metric: Selected Metric Returns: - _type_: Plotly Figure + Plotly Figure """ # 3d spring layout pos = nx.spring_layout(graph, dim=3) diff --git a/src/aki_prj23_transparenzregister/utils/networkx/networkx_data.py b/src/aki_prj23_transparenzregister/utils/networkx/networkx_data.py index dba0356..4d20789 100644 --- a/src/aki_prj23_transparenzregister/utils/networkx/networkx_data.py +++ b/src/aki_prj23_transparenzregister/utils/networkx/networkx_data.py @@ -173,7 +173,7 @@ def create_edge_and_node_list( company_relations (pd.DataFrame): _description_ Returns: - _type_: _description_ + _description_ """ nodes: dict = {} edges: list = [] @@ -296,7 +296,7 @@ def create_edge_and_node_list_for_company( company_relations (pd.DataFrame): _description_ Returns: - _type_: _description_ + _description_ """ nodes: dict = {} edges: list = []