Pometry / Raphtory

Scalable graph analytics database powered by a multithreaded, vectorized temporal engine, written in Rust
https://raphtory.com
GNU General Public License v3.0
336 stars 54 forks source link

Fixed documentation to state nodes instead of edges for find_nodes #1648

Closed brandon-haugen closed 3 months ago

brandon-haugen commented 3 months ago

What changes were proposed in this pull request?

Documentation fix

Why are the changes needed?

The documentation currently states that find_nodes returns edges which is wrong.

find_nodes(properties_dict)
Get the edges that match the properties name and value :param property_dict: the properties name and value :type property_dict: dict

This PR corrects the documentation so it says nodes instead of edges.

Does this PR introduce any user-facing change? If yes is this documented?

No, it just updates documentation strings so they use the correct object for the function being described

How was this patch tested?

Unfortunately, I have not been able to get the documentation to build locally yet...

Issues

None

Are there any further changes required?

No