Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python API is under-documented #29

Open
elistevens opened this issue May 26, 2017 · 3 comments
Open

Python API is under-documented #29

elistevens opened this issue May 26, 2017 · 3 comments

Comments

@elistevens
Copy link

In specific, loader.py doesn't have FileLoader mentioned at all, nor do the docs spell out the accepted filename extensions for PackageLoader.

Also, the online docs seem to be from v0.4.

Are there any initiatives to improve the situation?

@amol-
Copy link
Collaborator

amol- commented May 27, 2017

Yes, that has been pretty much left behind because the primary way to use Kajiki is through TurboGears which provide a customised loader and sets things up for you. So documentation on custom usage of kajiki has left little behind.

Also make sure you look at http://kajiki.readthedocs.io/ that the last version of documentation

@elistevens
Copy link
Author

Thanks for the link.

The github README, the pypi page, and even the readthedocs page itself all link to the older pythonhosted docs, FYI. :)

@amol-
Copy link
Collaborator

amol- commented May 27, 2017

Fixed! They were all including README.rst which had the wrong link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants