https://sourceforge.net/p/sqlobject/support-requests/5/2006-08-16T07:55:56ZRecent changes to 5: SQLObject documentation2006-08-16T07:55:56Z2006-08-16T07:55:56ZMichel Alberthttps://sourceforge.net/u/exhuma/https://sourceforge.net6ce9169c991d8dd9130572b50e589a568d6d404b

<div class="markdown_content"><p>Hi,</p> <p>SQLObject is a brilliant project and it's much fun <br /> working with it..... Once you figured out the details. <br /> SQLObject suffers from a *horrid* documentation.</p> <p>Starting a project from scratch is explained well <br /> enough. But if you have to re-use an existing <br /> database. It's inevitable that you need to use more <br /> advanced features of SQLObject. And those are only <br /> badly (if at all) documented. For example:</p> <p>You can use a different "Style" object to indicate<br /> a different naming convention.</p> <p>But which "Style" objects exist? What are the <br /> parameters? Is it possible to create a Style object <br /> yourself? If so, how? What methods need to be <br /> overridden and what do they need to do?</p> <p>You might say: "Hey, it's open-source. Browse the <br /> source code and see for yourself." And that's fine by <br /> me. But then, *please* document the code! My first try <br /> was to open up the python interpreter and do a <br /> &gt;&gt;&gt; help(SQLObject)<br /> and go from there. Nothing useful showed up.</p> <p>Honestly, for me time is money, and I was really close <br /> to giving up with SQLObject for this reason. However I <br /> like SQLObject. So I'll take a sip of vinegar and <br /> stick with it. After doing a lot of digging, I got <br /> most things to work. But not necessarily the way I <br /> want them to. Alas, it works.</p> <p>The gist of this message is: There might be people <br /> less willing to do some research, and drop SQLObject <br /> quickly. It would be sad, if SQLObject suffers from <br /> it's lack of documentation. And if I understood more <br /> of it's inner-workings, I would offer you to write <br /> some documentation, and even redesign the web-page, as <br /> -- quite frankly -- it has a bit of a chaotic look. <br /> The way I understand it, it's automatically generated, <br /> so it's not your fault.</p> <p>Anyhow, I hope you read this message as positive <br /> criticism and not as a rant/flame. As it was not <br /> intended as such.</p> <p>Best regards,</p> <p>Michel Albert</p> <p>p.s.: is it possible to do a naming style that works <br /> like mixed-case, but keeps the first letter small? Or <br /> even better, one that completely keeps the style of <br /> the variable (does no modifications whatsoever)? </p></div>