Skip to content

Commit

Permalink
docs(DOT): fix an error and clarify (#215)
Browse files Browse the repository at this point in the history
There was an error in this which used the legacy property name as a name
of the export (legacy: `vis.network.convertDOTNetwork`, new:
`vis.parseDOTNetwork`, docs: `vis.convertDOTNetwork`).

Also the text was rewritten to clarify it's meaning as the original
formulation was quite ambitious.

Closes #214.
  • Loading branch information
Thomaash authored and yotamberk committed Nov 10, 2019
1 parent 074bb65 commit e3ef6a7
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/network/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1708,10 +1708,11 @@ <h3 id="importDot">Import data in DOT language</h3>
<p>
Network supports data in the
<a href="http://en.wikipedia.org/wiki/DOT_language" target="_blank">DOT language</a>.
To use data in the DOT language, you can use the vis.convertDOTNetwork converter to transform the DOT
language
into a vis.Network compatible nodes, edges and options objects. You can extend the options object with other
options if you'd like.
To use data in the DOT language, you can use the
vis.parseDOTNetwork converter function to transform the DOT
language string into a Vis Network compatible nodes, edges and
options. You can alter or extend the returned nodes, edges and
options if you like.
</p>

<p>
Expand All @@ -1721,7 +1722,7 @@ <h3 id="importDot">Import data in DOT language</h3>
<pre class="prettyprint lang-js">
// provide data in the DOT language
var DOTstring = 'dinetwork {1 -> 1 -> 2; 2 -> 3; 2 -- 4; 2 -> 1 }';
var parsedData = vis.convertDOTNetwork(DOTstring);
var parsedData = vis.parseDOTNetwork(DOTstring);

var data = {
nodes: parsedData.nodes,
Expand Down

0 comments on commit e3ef6a7

Please sign in to comment.