diff --git a/README.rst b/README.rst index 92c0a37..5c4157e 100644 --- a/README.rst +++ b/README.rst @@ -16,7 +16,7 @@ be easy to use, and not require much configuration. AutoAPI is a parse-only solution for both static and dynamic languages. -This is in contract to the traditional `Sphinx autodoc `_, +This is in contrast to the traditional `Sphinx autodoc `_, which is Python-only and uses code imports. Full documentation can be found on `Read the Docs `_. diff --git a/docs/design.rst b/docs/design.rst index 3ee3d7a..e13ea6f 100644 --- a/docs/design.rst +++ b/docs/design.rst @@ -154,3 +154,15 @@ The .Net domain will not be able to depend on importing code from the users code .. autodnclass:: System.String :members: + + + +Design +======= + +Every object needs a unique identifier + +* Loader + - Get a dict of {filename: dictionary of data} +* Mapper + - Transforms a list of all objects generated \ No newline at end of file