@Steve:
Indeed, there already is some existing material about
`transaction`, `pyramid_tm`
in all the different places, that I missed: Thank you for all the pointers,
specifically those following (I detail for the record):
* in 'Pyramid for Pylons users'
* in 'INI' section, a short description of `pyramid_tm`
(http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/pylons/ini_file.html?highlight=transaction),
* in 'Models' section, a well written explaination about
`transaction` with `pyramid_tm`,
that I loved red before
(http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/pylons/models.html?highlight=transaction#transaction-manger)
* also in the wiki tutorial:
* in 'Basic layout' section, a description of `sessionmaker`
and `scoped_session`
(http://docs.pylonsproject.org/projects/pyramid/en/master/tutorials/wiki2/basiclayout.html#content-models-with-models-py)
* in 'Installation' section, a listing mentioning which
opinions alchemy`'s scaffold will make,
including use of `zope.sqlalchemy` and `pyramid_tm`
(http://docs.pylonsproject.org/projects/pyramid/en/master/tutorials/wiki2/installation.html#decisions-the-alchemy-scaffold-has-made-for-you)
* as in the 'getting started' tutorial, in the 'Using database
with SQLAlchemy' section,
other occurence for description about `transaction` and `pyramid_tm`
(http://docs.pylonsproject.org/projects/pyramid_tutorials/en/latest/getting_started/11-sqlalchemy/index.html#analysis),
* and in the 'blogr' tutorial, in the 'Create database models', a
newbies friendly introduction of why and how use them
(http://pyramid-blogr.readthedocs.org/en/latest/basic_models.html#database-session-management)
So, what I considered a piece of information which should IMHO
stands in main documentation,
more precisely in narrative doc., or at least in the cookbook in
"obvious" location under 'SQLAlchemy' section,
actually stands in different forms in many and different yet not
so obvious locations
-- those related to Pylons, and tutorials.
I'll see later if there is prerequisities (i.e. licenses) to do
some new section which will merge
all these materials, more completed and better written that mine.
Do you guys have strong opinion about location of this possible new section?
2013/7/15 Steve Piercy <[email protected]>:
> 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.
>
>
--
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.
