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.

Sign up for GitHub

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

Jump to bottom

Documentation is lacking #22

Open
cgsmith opened this issue Jun 19, 2014 · 2 comments
Open

Documentation is lacking #22

cgsmith opened this issue Jun 19, 2014 · 2 comments
Labels
enhancement

Comments

@cgsmith
Copy link

cgsmith commented Jun 19, 2014

It is very hard to figure out how to use the library without navigating to the classes to find out what each method is used. For example, to a novice, saving a file on the filesystem is not evident.
@johnblythe
Copy link

Some of the documentation isn't up to date, either. getRows is now getRecords, etc.

faisalman added a commit that referenced this issue Nov 3, 2014
@faisalman
Correcting docs #22: getRow becomes getRecord
6a4f8e1
@davidjeddy
Copy link
Contributor

Recommendation: Run phpDocumentor over the project: https://www.phpdoc.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@faisalman @cgsmith @johnblythe @davidjeddy