Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve "introduction" page, add "Advanced Features" page #2634

Merged
merged 34 commits into from
Jun 6, 2017
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
335200e
be assertive in claims
cewing Jun 3, 2016
66b7151
clarify the framework sidebar
cewing Jun 3, 2016
9f2b004
simplify the statement of principles
cewing Jun 3, 2016
f920852
rewrite what makes pyramid unique
cewing Jun 3, 2016
02c5ba3
make title an action
cewing Jun 3, 2016
6fcca68
fix decorator configuration section
cewing Jun 3, 2016
dc7c27b
fix generated urls section
cewing Jun 3, 2016
8c12559
fix static assets section
cewing Jun 3, 2016
0c40650
update the dynamic development section
cewing Jun 4, 2016
0027f5d
update the debugging sections
cewing Jun 4, 2016
f9822db
updated extensions section
cewing Jun 4, 2016
42089ef
re-write the views section
cewing Jun 4, 2016
86ed4c1
emphasize that the views are yours
cewing Jun 4, 2016
0967f59
improve section title a bit more
cewing Jun 4, 2016
ff14e5d
fix up headline a bit
cewing Jun 7, 2016
9b942a4
update asset specification section
cewing Jun 7, 2016
5404f9c
update information about extensible templating
cewing Jun 7, 2016
1610c8f
update section on returning dictionaries from views
cewing Jun 7, 2016
03f6d63
Merge branch 'master' into issue.2614
cewing Oct 22, 2016
7c68093
updates to narrative docs introduction, fixing for clarity and concision
cewing May 22, 2017
b033b96
Merge branch 'master' into issue.2614
cewing May 22, 2017
26c90db
move more esoteric framework features into a separate file to remove …
cewing May 22, 2017
f47d226
simplify the section comparing pyramid with other web frameworks
cewing May 22, 2017
52ff50f
Updating wording in the advanced features doc to make it more accessible
cewing May 22, 2017
f20a018
fixes per code review, Thanks @stevepiercy.
cewing May 24, 2017
44c621a
finish polishing the advanced configuration doc per code review
cewing May 24, 2017
e20ed7d
fix code indentation and unify style for all code blocks, per CR
cewing May 25, 2017
981a9df
fix more style issues per CR
cewing May 25, 2017
f42ab13
use str in deference to Py3 style over Py2
cewing Jun 3, 2017
a419bcd
more fixes for CR
cewing Jun 3, 2017
794fd35
finish all app references for Pyramid and refold line lengths
cewing Jun 3, 2017
be4b64f
fix more comments and refold lines, one per paragraph as specified in…
cewing Jun 5, 2017
719ab35
fix a few more comments, and reflow introduction document to one line…
cewing Jun 5, 2017
381fe10
restore the r. it's important
cewing Jun 6, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion docs/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -751,7 +751,7 @@ Glossary
:ref:`Venusian` is a library which
allows framework authors to defer decorator actions. Instead of
taking actions when a function (or class) decorator is executed
at import time, the action usually taken by the decorator is
at :term:`import time`, the action usually taken by the decorator is
deferred until a separate "scan" phase. :app:`Pyramid` relies
on Venusian to provide a basis for its :term:`scan` feature.

Expand Down Expand Up @@ -1172,3 +1172,34 @@ Glossary
A policy which wraps the :term:`router` by creating the request object
and sending it through the request pipeline.
See :class:`pyramid.config.Configurator.set_execution_policy`.

singleton
A singleton is a class which will only ever have one instance.
As there is only one, it is shared by all other code.
This makes it an example of :term:`global state`.

Using a singleton is `considered a poor design choice. <https://softwareengineering.stackexchange.com/questions/148108/why-is-global-state-so-evil>`_
As :term:`mutable` global state, it can be changed by any other code,
and so the values it represents cannot be reasoned about or tested properly.

global state
A set of values that are available to the entirety of a program.

mutable
In Python, a value is mutable if it can be changed *in place*.
The Python ``list`` and ``dict`` types are mutable.
When a value is added to or removed from an instance of either, the original object remains.
The opposite of mutable is :term:`immutable`.

immutable
In Python, a value is immutable if it cannot be changed.
The Python ``str``, ``int``, and ``tuple`` data types are all ``immutable``.

import time
In Python, the moment when a module is referred to in an ``import`` statement.
At this moment, all statements in that module at the module scope (at the left margin) are executed.
It is a bad design decision to put statements in a Python module that have :term:`side effect`\ s at import time.

side effect
A statement or function has a side effect when it changes a value outside its own scope.
Put another way, if one can observe the change made by a function from outside that function, it has a side effect.
Loading