It's been recognized that the organization of documentation
could be better. There are at least 3 projects with Pyramid
documentation on GitHub.
Meanwhile here are some relevant tutorials and cookbook recipes
that might help. You can compare your documentation to existing documentation.
http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/
#4 recipes here
http://docs.pylonsproject.org/projects/pyramid/en/master/tutorials/wiki2/index.html
http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/
You can contribute documentation to Pyramid through GitHub. To
do so, you need to sign:
https://github.com/Pylons/pyramid/blob/master/CONTRIBUTORS.txt
Then follow these directions:
https://github.com/Pylons/pyramid/blob/master/HACKING.txt#L121
HTH.
--steve
On 7/15/13 at 5:10 PM, [email protected] (fero14041) pronounced:
Hi, Pyramid's users!
[Please excuse any misspelling/wording from a non-english user]
Being pretty new to both Pyramid and SQLAlchemy, I have some
non-understood code,
thanks 'alchemy' scaffold, which is also shared across several
tutorials on the web.
This is line::
DBSession = scoped_session(sessionmaker(extension=ZopeTransactionExtension())
and the later calls to this :data:`DBSession`.
First, I apologize to start reading the docs before calling help or
search this mailing-list.
In order to understand what appears magic to newbies as me,
I wrote some step by step documentation with explanations of what I
understood of
used modules respective documentations.
I feel that there is a documentation lack somewhere, at least for newbies,
with material which could be seen by experienced users as obvious.
It is possible I'm not alone to feel so, as at least one previous
message in this list
points similar incomprehension:
https://groups.google.com/forum/#!topic/pylons-discuss/_QK_dXXM_K4
and recent discussion seems related to this subject:
https://groups.google.com/forum/#!topic/pylons-discuss/R4S-UwHV6ww
https://groups.google.com/forum/#!topic/pylons-discuss/LNQCIBrFBbg
Here's the code, versionned by Mercurial:
http://pyramid.poeulfs.org/hg/sqla-doc/
and there is the rendered doc in HTML:
http://pyramid.poeulfs.org/doc/sqla-doc/
So, my first ask concerns the accuracy of this writing:
could some of you experienced users review it, please?
And if you think this is possible and desirable, the second wish would be
to include it (as your convenience) in Pyramid's documentation
-- perhaps in its cookbook?
I'm almost sure that the present draft could be corrected, developed
and completed:
what do you guys think about?
Cheers,
-- fero14041
------------------------
Steve Piercy, Soquel, CA
--
You received this message because you are subscribed to the Google Groups
"pylons-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/pylons-discuss.
For more options, visit https://groups.google.com/groups/opt_out.
