needs documentation
Opened this issue · 7 comments
I'm considering (either, or both) the following 2 options:
- extend readme with some basic examples;
- create api documentation and use the
gh-pagesbranch.
Any chance of getting some documentation on this? It's not at all clear how to use it as it stands?
The chance is quite high. It is more a question of when. I have limited time available. Anyone can contribute this if they want to. Simply add relevant document(s) to the docs folder.
The first thing that should be documented is the interface (it is really quite trivial), which can be found in DataProvider.php.
After that, documentation can be extended to include details about how to load a customized dataset and such (but this is less important, cause anyone going down this path can probably figure it out from the code themselves).
Idea: Run phpDocumentor over the project and publish to gh-pages? I know it is not an all inclusive solution but would provide a start. I'd be happy to do this for you @alcohol.
That only provides a very basic API summary. I've added the interface methods already. You're free to add the phpdoc output to the existing docs. See the docs directory. I don't publish the docs through a gh-pages branch, since that is no longer necessary after the changes Github introduced.
Per comment on #30 (comment) ; what did you have in mind for documentation?
Just another one or two pages on top of what is currently in docs/. A very brief description of the methods, their signature, and perhaps explaining what they do (if it isn't obvious from the name and signature yet).
Ah, ok. Now I understand what you were looking for.