dominikbraun / graph

A library for creating generic graph data structures and modifying, analyzing, and visualizing them.
https://graph.dominikbraun.io
Apache License 2.0
1.8k stars 94 forks source link

Update documentation to explicitly ignore errors returned by `AddVertex` #54

Closed dominikbraun closed 1 year ago

dominikbraun commented 1 year ago

At the moment, AddVertex calls in the documentation (README + GoDoc) look like this:

g.AddVertex(1, 2)

But AddVertex returns an error, and that should be made clear in the docs. The error should be ignored explicitly, just as with the AddEdge calls:

_ = g.AddVertex(1, 2)

Again, this should be done in both the README and the code comments.

vinicio commented 1 year ago

Hi! Can I take this one?

dominikbraun commented 1 year ago

Sure 🙂