Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation for Directed Edges (createEdgeDirected method) #69

Open
antonioacampos opened this issue Oct 22, 2024 · 1 comment
Labels

Comments

@antonioacampos
Copy link

I noticed that the current documentation for the Graphp/GraphViz library shows the use of the method createEdgeDirected to create directed edges from a Graph object, like this:
$graph = new Graphp\Graph\Graph();

$edge = $graph->createEdgeDirected($blue, $red);
However, it seems that the library has been updated, and the method createEdgeDirected no longer exists. Now, edges can be created from vertices using createEdgeTo instead, as shown below:

$transitionVertex = $graph->createVertex($transitionName);
$transitionVertex->createEdgeTo($toPlace);

It would be great to update the documentation to reflect this change, so that developers can follow the current implementation more easily. I am happy to help with this update if needed.

@kulsoom2003
Copy link

It seems that changes were made to the API from createEdgeTo to createEdgeDirected in #166, #175, and #178 for a more explicit distinction between directed and undirected edges. Unless I am missing a more recent update, this may be the reason for inconsistency.

Please could you provide a link for any page in the documentation using createEdgeTo, or an inconsistent mention of createEdgeDirected?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants