Skip to content

Commit

Permalink
[docs] added note on abcs
Browse files Browse the repository at this point in the history
  • Loading branch information
maxfischer2781 committed Aug 3, 2017
1 parent ffcf4d0 commit 9ef4a3d
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ Frequently Asked Questions
The goal of ``GraphI`` is not to be another graph library, but to provide an intuitive graph interface.
Working with complex graphs should be as easy *for you* as working with any other primitive type.

*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>`.

Any custom graph implementation can be made a *virtual* subclasses of these ABCs.
This allows you to adopt graph implementations optimized for your use-case without changing your code.

*Where are all the algorithms?*
First and foremost, ``GraphI`` is designed for you to *work on graph data* instead of pre-sliced storybook data.
``GraphI`` implements only algorithms that
Expand Down

0 comments on commit 9ef4a3d

Please sign in to comment.