Improve docstrings #944
Improve docstrings #944
Conversation
✅ Deploy Preview for neo4j-graph-data-science-client canceled.
|
|
@FlorentinD The two top commits on this PR are from me, so I am not sure if it makes sense for me to review. But I can rebase to make this more apparent. |
Mats-SX
force-pushed
the
AV2_doc_improvements
branch
2 times, most recently
from
122c599 to
29bf543
Compare
- Content copied as much as possible from GDS Manual - Add default values
- Content copied as much as possible from GDS Manual - Add default values
Mats-SX
force-pushed
the
AV2_doc_improvements
branch
from
5e80e0f to
68c233b
Compare
| Runs the Articulation Points algorithm and stores the results in the graph catalog as a new node property. | ||
| Given a graph, an articulation point is a node whose removal increases the number of connected components in the graph. | ||
| The Neo4j GDS Library provides an efficient linear time sequential algorithm to compute all articulation points in a graph. |
There was a problem hiding this comment.
do we want to refer here to the Neo4j GDS Library?
IMO, we can skip the last sentence as well.
There was a problem hiding this comment.
I agree, can take this away.
There was a problem hiding this comment.
Thanks for reading through it
There was a problem hiding this comment.
I was thinking when I did this that I didn't want to deviate from the GDS manual because then there'd be two sources of truth. So I have only copied lines, but the amount of copying is varying. I was thinking that having nice one-liners and one-paragraphers to describe the algorithm is a useful thing also in the manual itself, but I didn't want to scope creep too much. So I think just taking some verbatim content from the manual is my current approach
|
PR build failures are not specific to this PR. |
Co-authored-by: Florentin Dörre <[email protected]>
Based on #942ref GDSA-233