Oh, I was not aware. The 05 docs is, as you say, addressing some of my points.
Thanks On May 22, 1:14 am, semafor <jo...@drange.net> wrote: > Hi. > > Currently, the documentation for SA is not easy for the eyes. > Usinghttp://www.sqlalchemy.org/docs/04/sqlalchemy_engine.htmlas an > example, there are ways to improve this: > > * Quasi syntax highlighting the function and it's arguments. > > Having "def create(self, entity, **kwargs)" all in bold is making it > hard to browse through the functions by name as, at least, I often do. > > I also takes some effort separating the arguments from each other. For > instance, "close_with_result=False" is also all in bold. "False" > should undoubtedly be of a different format than the argument name. > > * Differentiate class documentation from function documentation. > Today, the class header is just ~2px larger than the function header, > i.e., not a big enough deviation. Using 30%+ larger header or wrapping > it in a styled box should do it. > > * De-emphasizing "back to section top". The link is almost the same > size as the class ancestor (constructor argument), which requires > effort to separate. > > * The "darkcell" div is indeed superfluous. One could create the same > effect of division with white space and/or horizontal bordering. > > * Emphasizing class properties and module includes. The default > indentation of definition data is not sufficient. > > * Generally using white space more efficiently. > > I could happily assist someone in charge of the site, or do it myself. > For the latter, I probably need some approval, branches of both > sqlalchemy and sqlalchemyorg repos, or both? > > Anyway, SA is an impressive project. > > Kind regards, Jonas. --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "sqlalchemy" group. To post to this group, send email to sqlalchemy@googlegroups.com To unsubscribe from this group, send email to sqlalchemy+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sqlalchemy?hl=en -~----------~----~----~----~------~----~------~--~---
