enthought / enthought/pyql

Pain point: Not enough documentation

Open
#261 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Cython
Stars
1.3k
Forks
235
PR merge metrics
No merged PRs in 30d

Description

Hi I am a new user to pyql.
After installation and giving it a try for the past week, I found that the library is lacking tutorial and documentation.
Maybe the library is good enough for the developers of this library, but this library is not providing enough guidance for new comers.

The amount of notebook/script examples are limited. And they do not systematically explain how to utilize the library.
As a comparison, the documentation and start guide of pandas library does a good job bringing new users into the door.

This library might be a good one. But the potential is largely limited by the bar it sets for the users. The user has to understand well how Quantlib or SWIG implementation works before to take full advantage of this lib.

Though I prefer pythonic way of handling things, I will have to switch to SWIG implementation for this reason.
Hope this can be improved in the future.

Thank you for your work all the time.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.