search

networkx / nx-parallel

A networkx backend that uses joblib to run graph algorithms in parallel.
BSD 3-Clause "New" or "Revised" License
34 stars 21 forks source link

BUG: moved `get_info` from `backend.py` to `_nx_parallel` #53

Closed Schefflera-Arboricola closed 8 months ago

Schefflera-Arboricola commented 8 months ago

Please do "Squash and merge" while merging this PR

fixes https://github.com/networkx/nx-parallel/issues/52

for ref. https://github.com/networkx/nx-parallel/pull/27

dschult commented 8 months ago

I don;t think you need to make the additional parameters dict. It is a helpful structure if you already know the parameter names and corresponding docs. But when you are pulling from existing doc_strings on these functions, it is probably easier to just extend the additional_docs string with the parameter descriptions.

That is: you can add the parameter section of the doc_strings to the additional_docs field (leaving additional_parameters blank) rather than parsing and making the dict structure required foradditional_parameters`.