Hey guys,
I'm working my way through all the newbie docs so as to decide if
pylons is the answer to somethings I don't like about django or if I
should just get down with django-alchemy or something instead.
While working through the quickwiki tutorial, I've come across a few
bits that I think could use a bit of clarification, and superfly on
IRC said this would be the appropriate place to mention them.
The first thing is that most all of the paths are given relative to
the inner quickwiki folder(the app folder?) rather than the outer
QuickWiki folder. Obviously this won't trip up any experienced
hackers, but I've got a friend of mine working through the tutorial as
well, and I'm curious to see how he responds to the mentions of all
these files that actually live at different places.
Later, under the heading Application Setup, we are asked to edit
websetup.py. We insert the line
meta.metadata.create_all(bind=meta.engine)
but then in the explication this is discussed as if we had inserted
meta.metadata.bind = meta.engine
model.metadata.create_all(checkfirst=True)
which I presume is from an earlier version of the code, as find|grep
showed me no occurances of this text.
In general, the code sections seem to be presented as a mix of "here's
an entire file" and "here's a code snippet to add". Sometimes the
lines of "the entire file" are partially present in what paster has
generated, which leads me to just edit the file and stick in what I
think is different. This can be a bit error prone and lead the reader
to miss out on an import statement or something. It's solely a
stylistic complaint, but I feel like presenting a "patch" or a diff
file here will lead to a better experience for the user of the
tutorial. A side by side diff would of course be the most explicit
thing, but I don't know how much of a pain in the ass that would be to
provide and maintain. Autogenerating a side-by-side diff for these
code sections could potentially help with keeping the prose in sync
with the code.
Also, I just noted while trying to resolve whether or not I wanted to
create the pages controller under QuickWiki or QuickWiki/quickwiki
that there is no mercurial repo up at
http://www.knowledgetap.com/hg/QuickWiki
Cheers,
Alex
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"pylons-discuss" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/pylons-discuss?hl=en
-~----------~----~----~----~------~----~------~--~---
