Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
maxfischer2781 committed Nov 17, 2017
1 parent 3bde846 commit 6febc6e
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Frequently Asked Questions

*What is this thing you call ABC?*
``GraphI`` does not just provide graph *implementations*, but also an efficient graph *interface*.
This interface is defined by the :py:class:`graphi.abc` :term:`abstract base classes <abstract base class>`.
This interface is defined by the :py:mod:`graphi.abc` :term:`abstract base classes <abstract base class>`.

Any custom graph implementation can be made a *virtual* subclass of these ABCs.
This allows you to adopt graph implementations optimized for your use-case without changing your code.
Expand All @@ -82,6 +82,8 @@ Frequently Asked Questions

2. benefit from knowledge of internal data structures.

At the moment, you can find basic operators in the :py:mod:`graphi.operators` module.

*What about performance?*
At its core, ``GraphI`` uses Python's native, highly optimized data structures.
For any non-trivial graph algorithm, the provided performance is more than sufficient.
Expand Down
2 changes: 2 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ prerelease 2017-??-??

- ``neighbours(graph, node, ..)``

- ``density(graph)``

Added input/output:

- csv
Expand Down
2 changes: 1 addition & 1 deletion graphi/graph_io/csv.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Utilities for loading and storing Graphs
Utilities for loading and storing Graphs as csv
"""
from __future__ import absolute_import
import csv
Expand Down

0 comments on commit 6febc6e

Please sign in to comment.