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

Documentation #66

Open
hatemysqlnative opened this issue May 30, 2012 · 3 comments
Open

Documentation #66

hatemysqlnative opened this issue May 30, 2012 · 3 comments

Comments

@hatemysqlnative
Copy link

This library has no documentation at all. If it weren't for the reverse engineering of code I would never have gotten this to work. The reason this may be better than nodejs-mysql but has less adoption is because you can't figure out how to use it without reading the source, which is not commented. The names are not always very verbose either. If you want people to adopt and contribute then make simple guides. There are places in the issues in which you yourself didn't remember that escape is in the library. Just spend a few hours and document or heavily comment your code. Make it more user friendly and it would receive worlds more use and praise. As it is its a nightmare to get going and try to interpret what you did in the code.

@sidorares
Copy link
Owner

Are you referring to user API documentation (which is in readme) or implementation documentation?

@hatemysqlnative
Copy link
Author

If the readme covers ANY of what I have mentioned then I am a Monkey's Uncle. As it does not, I am not a monkey's Uncle.

It covers nothing of escape, auto_prepare, hash_to_row, expect formats of ANY of the functions.

It says overly simplified things like default is localhost:3306. So are you suppose put your host colon port. Hell, no that doesn't work, but you'd have no idea if you didn't go read the function.

You want to know why people don't use this. THAT is why. It takes a expert level coders 5-8 hours to set up, because of the complete utter lack of documentation, commenting or verbose variable/input names.

@Pulsar-san
Copy link

I second what hatemysqlnative says.
We need a real HOWTO for mysql-native.
For example :
How do we get a result set from a real database ?
How do we read that result set ?
Can we get an object like $obj = $result->fetch_object() in php ?

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

3 participants