Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

reorder index page (FAQ higher), some wording tweaks, rejigger note a…

…bout please-help-us-help-you in support, move some wording between pylonsproject and pyramid
  • Loading branch information...
commit 5854365fda4430bf679faa44f7bf842ef1e07c8d 1 parent 98eb2e0
@mcdonc mcdonc authored
View
18 community/codestyle.rst
@@ -110,9 +110,12 @@ mandatory.
Imports should be ordered by their origin. Names should be imported in
this order:
- 1) Python standard library
- 2) 3rd party packages
- 3) Other modules from the current package
+
+ #. Python standard library
+
+ #. Third party packages
+
+ #. Other modules from the current package
* Wildcard Imports
@@ -141,3 +144,12 @@ mandatory.
if default is None:
default = {}
+* Causing others to need to rely on import-time side effects is highly
+ discouraged.
+
+ Creating code that requires someone to import a module or package for the
+ singular purpose of causing some module-scoped code to be run is highly
+ discouraged. It is only permissible to add such code to the core in paster
+ templates, where it might be required by some other framework
+ (e.g. SQLAlchemy "declarative base" classes must be imported to be
+ registered).
View
5 faq/pylonsproject.rst
@@ -112,11 +112,6 @@ Friendly". Everything we do, from the already-ready Pyramid to the various
batteries we want to do later in batteries-included projects, should retain
these qualities.
-Specifically, if you like meat-and-potatoes stuff like insanely great and
-up-to-date docs, a magnificently-tested web framework, and a slim execution
-footprint, you'll like Pyramid. If you're also curious in fresh new ideas
-about extensibility, come hang out with us and throw your ideas into the mix.
-
What do you mean by "Friendly"?
-------------------------------
View
5 faq/pyramid.rst
@@ -46,6 +46,11 @@ contributors are long-time Python web framework developers with lots of
experience. It also has momentum based on a convergence of its (previously
divided) communities.
+Specifically, if you like meat-and-potatoes stuff like insanely great and
+up-to-date docs, a magnificently-tested web framework, and a slim execution
+footprint, you'll like Pyramid. If you're also curious in fresh new ideas
+about extensibility, come hang out with us and throw your ideas into the mix.
+
What do you mean by "Small"?
-----------------------------
View
68 index.rst
@@ -13,55 +13,67 @@ Skip to:
`Jinja2 <http://jinja.pocoo.org/>`_ template renderer for pyramid_
* `pyramid_xmlrpc </pyramid_xmlrpc/dev/>`_, XML-RPC add-on for pyramid_
-Mailing List and Online
------------------------
+.. _pyramid: /pyramid/dev/
+
+Support
+-------
Development questions related to Pylons projects can be discussed on the
-`pylons-dev mail list <http://groups.google.com/group/pylons-devel/>`_.
+`pylons-devel mail list <http://groups.google.com/group/pylons-devel/>`_.
On IRC, Pylons developers are generally available on the ``#pylons`` channel
on the `Freenode IRC Network <http://freenode.net/>`_.
-.. note::
-
- *Try to spend some time solving a problem yourself before asking others
- for help.*
- While it can be tempting to jump straight to IRC to ask for help, many
- problems can be solved by yourself. Giving it a shot first on your own,
- will be less imposing on others you ask for help.
+.. topic:: Using Support Wisely
-Contributing
-------------
+ Before asking a technical question on the maillist(s) or in IRC, please
+ make sure to try the following things (paraphrased from `Before You Ask
+ <http://www.catb.org/~esr/faqs/smart-questions.html#before>`_):
-The Pylons Project welcomes contributors, to encourage a strong and vibrant
-community please read the following documentation about how the Pylons Project
-functions, coding styles expected for contributions, and the community
-standards we expect everyone to abide by.
+ - Try to find an answer by reading the manual.
-.. toctree::
- :maxdepth: 2
+ - Try to find an answer by searching the maillist archives.
- community/conduct
- community/codestyle
- community/featuresbugs
+ - Try to find an answer by searching the Web.
+
+ - Try to find an answer by inspection or experimentation.
+
+ - If you're a programmer, try to find an answer by reading the source
+ code.
+
+ After exhausing these avenues, it's completely appropriate to ask a
+ question on the Pylons-devel maillist or #pylons IRC channel. When you
+ ask your question, please describe what you've learned from the efforts
+ above, as it will help the developers focus on answering your question
+ quickly. It also helps tremendously if you are able to provide a code or
+ configuration snippet that makes the problem easily repeatable.
FAQ
---
-For Pylons users coming from Pylons 1, the change to a new core package might
-raise some questions regarding how to proceed, what it means for existing
-Pylons application, and more.
-
-Likewise for users of repoze.bfg (the older name for Pyramid), some questions
-need to be answered.
+For Pylons users coming from Pylons 1 or repoze.bfg the change to a new core
+package might raise some questions regarding how to proceed, what it means
+for existing applications.
.. toctree::
faq/pylonsproject
faq/pyramid
+Contributing
+------------
+
+The Pylons Project welcomes contributors. Please read the following
+documentation about how the Pylons Project functions, coding styles expected
+for contributions, and the community standards we expect everyone to abide
+by.
-.. _pyramid: /pyramid/dev/
+.. toctree::
+ :maxdepth: 2
+
+ community/conduct
+ community/codestyle
+ community/featuresbugs
Denials
-------
Please sign in to comment.
Something went wrong with that request. Please try again.