search

RDFLib / rdflib

RDFLib is a Python library for working with RDF, a simple yet powerful language for representing information.
https://rdflib.readthedocs.org
BSD 3-Clause "New" or "Revised" License
2.18k stars 560 forks source link

Fully document interface #113

Closed ghost closed 12 years ago

ghost commented 12 years ago

eik...@gmail.com, 2010-02-13T01:26:48.000Z

Clean up and fully document interface. Currently the interface and various plugin implementations are intermixed; the interface is easier to define and document if we separate one from the other.

Also, we could benefit from defining all in the interface modules to future clarify what's part of the interface vs. an implementation side effect (see the email package in the standard library for an example of this).

Comment 1 by eik...@gmail.com

See r1853 ( Still working on that commit syntax to associate commits with issues. )

Comment 2 by eik...@gmail.com

This issue was updated by revision r1854.

Moving parsers and serializer implementations into rdflib.plugins package

Comment 3 by eik...@gmail.com

This issue was updated by revision r1855, r1856, r1857, r1858.

Moving parsers and serializer implementations into rdflib.plugins package

Comment 8 by eik...@gmail.com

FYI, narrative doc update and location for API docs:

http://groups.google.com/group/rdflib-dev/browse_thread/thread/40db2db4b18e3c3c?hl=en

Comment 9 by gjhigg...@gmail.com

To re-create epydoc API docs, install epydoc and use the following command-line instruction to create a set of rdflib API docs in the directory "./apidocs" (relative to cwd):

$ epydoc -v --output apidocs --docformat reStructuredText --html rdflib

Comment 16 by gjhigg...@gmail.com

Added all lists to every source file.

gromgull commented 12 years ago

How are we doing on this? The docs have certainly seen enormous improvements since it was opened.

I say close now and reopen for specific issues as they arise.

ghost commented 12 years ago

Makes sense to me.