Update README.md #91
Update README.md #91
Conversation
First pass docs update
|
First pass of README update done largely with AI, passing the old README and changelog. @JesusTheHun Would you be able to please review this and flag any major issues? Thanks! |
README.md
Outdated
| @@ -23,17 +23,17 @@ This library is distributed only via [NPM](npmjs.com). Install by running | |||
| Require it in your code like this. | |||
|
|
|||
| ```javascript | |||
| const { Graph } = require('graph-data-structure'); | |||
| const { Graph, serializeGraph, deserializeGraph, topologicalSort, shortestPath } = require('graph-data-structure'); | |||
There was a problem hiding this comment.
Maybe it's type to use ESM ?
There was a problem hiding this comment.
Great idea! If you make inline suggestions with the "add a suggestion" tool I can commit the changes directly.
README.md
Outdated
| @@ -98,29 +98,29 @@ For more detailed example code that shows more methods, have a look at the [test | |||
|
|
|||
| Constructs an instance of the graph data structure. | |||
|
|
|||
| The optional argument _serialized_ is a serialized graph that may have been generated by **[serialize](#serialize)**. If _serialized_ is present, it is deserialized by invoking **[deserialize](#deserialize)**. | |||
| The optional argument _serialized_ is a serialized graph that may have been generated by **[serializeGraph](#serializeGraph)**. If _serialized_ is present, it is deserialized by invoking **[deserializeGraph](#deserializeGraph)**. | |||
There was a problem hiding this comment.
Nope, to deserialize the graph you have to call deserializeGraph(mySerializedObject). There constructor takes no parameter anymore
README.md
Outdated
|
|
||
| ### Adding and Removing Nodes | ||
|
|
||
| <a name="add-node" href="#add-node">#</a> <i>graph</i>.<b>addNode</b>(<i>node</i>) | ||
|
|
||
| Adds a node to the graph. Returns _graph_ to support method chaining. The argument _node_ is a string identifier that uniquely identifies the node within this graph instance. If a node with the same identifier was already added to the graph, this function does nothing. | ||
| Adds a node to the graph. Returns _graph_ to support method chaining. The argument _node_ can be any object or string that uniquely identifies the node within this graph instance. If a node with the same identifier was already added to the graph, this function does nothing. |
There was a problem hiding this comment.
I would remove the part on the identifier, as we now accept object, it has no meaning anymore. Or maybe "if the node already exists, this function does nothing"
|
|
||
| <a name="remove-node" href="#remove-node">#</a> <i>graph</i>.<b>removeNode</b>(<i>node</i>) | ||
|
|
||
| Removes the specified node. Returns _graph_ to support method chaining. The argument _node_ is a string identifier for the node to remove. This function also removes all edges connected to the specified node, both incoming and outgoing. | ||
| Removes the specified node. Returns _graph_ to support method chaining. The argument _node_ is a string or object identifier for the node to remove. This function also removes all edges connected to the specified node, both incoming and outgoing. |
There was a problem hiding this comment.
I would also add a warning but node that are object. You have to remove them using the exact same reference as when they were created. One can use getNode() to retrieve such reference
| - `source` The node identifier string of the source node (**u**). | ||
| - `target` The node identifier string of the target node (**v**). | ||
| - `source` The node reference of the source node (**u**). | ||
| - `target` The node reference of the target node (**v**). | ||
| - `weight` The weight of the edge between the source and target nodes. |
There was a problem hiding this comment.
You forgot the edge's properties, if any
| <a name="deserialize" href="#deserialize">#</a> <i>graph</i>.<b>deserialize</b>(<i>serialized</i>) | ||
|
|
||
| Deserializes the given serialized graph. Returns _graph_ to support method chaining. The argument _serialized_ is a graph representation with the structure described in **[serialize](#serialize)**. This function iterates over the serialized graph and adds the nodes and links it represents by invoking **[addNode](#add-node)** and **[addEdge](#add-edge)**. The output from **[serialize](#serialize)** can be used as the input to **deserialize**. | ||
| Deserializes the given serialized graph. Returns a new _graph_. The argument _serialized_ is a graph representation with the structure described in **[serializeGraph](#serializeGraph)**. |
There was a problem hiding this comment.
Makes me think that the serializeGraph could also use an identity function, to avoid the duplication of the data when using a node object.
Revisions.
|
OK I went through and addressed most of the feedback. Merging this now for upcoming release. Please feel free to update the README if you see any issues @JesusTheHun ! Thanks! |
First pass docs update