Consider adding examples or some documentation

c2nes / javalang

Pure Python Java parser and tools

MIT License

736 stars 161 forks source link

Consider adding examples or some documentation #5

Open AlexandreDecan opened 11 years ago

AlexandreDecan commented 11 years ago

This is a quite interesting Python package, but it lacks a decent documentation (docstring or a readme-like one) or at least, some examples.

c2nes commented 11 years ago

I've expanded the README to include some basic documentation and example for common usages. It will take some time to more thoroughly add docstrings to all the classes/methods, but hopefully the expanded README will help until this can be done.