[Python-checkins] devguide: Make "quickstart" section more consistent. Remove "indices and tables" section
georg.brandl
python-checkins at python.org
Fri Jan 13 22:09:35 CET 2012
http://hg.python.org/devguide/rev/dedeac10054e
changeset: 476:dedeac10054e
user: Georg Brandl <georg at python.org>
date: Fri Jan 13 22:09:35 2012 +0100
summary:
Make "quickstart" section more consistent. Remove "indices and tables" section that had no indices or tables.
files:
index.rst | 81 ++++++++++++++++++------------------------
1 files changed, 35 insertions(+), 46 deletions(-)
diff --git a/index.rst b/index.rst
--- a/index.rst
+++ b/index.rst
@@ -37,27 +37,27 @@
Quick Start
-----------
-Here is a list of the basic step necessary to get set up and make a patch:
+Here is a list of the basic steps necessary to get set up and make a patch:
-1. get :ref:`a clone of CPython <setup>` with
- ``hg clone http://hg.python.org/cpython``;
+1. Get :ref:`a clone of CPython <setup>` with ``hg clone
+ http://hg.python.org/cpython``.
2. On UNIX, run ``./configure --with-pydebug && make -j2`` to
:ref:`build Python <compiling>`.
On :ref:`Windows <windows-compiling>`, load the project file
:file:`PCbuild\\pcbuild.sln` in Visual Studio, select :menuselection:`Debug`,
- and :menuselection:`Build -> Build Solution`;
-3. :doc:`run the tests <runtests>` with ``./python -m test -j3``
- (use :file:`./python.exe` on :ref:`most <python.exe>` Mac OS X systems and
- :file:`PCbuild\\python_d.exe` on Windows);
-4. make the :doc:`patch <patch>`;
-5. submit it to the `issue tracker`_.
+ and :menuselection:`Build --> Build Solution`.
+3. :doc:`Run the tests <runtests>` with ``./python -m test -j3`` (use
+ :file:`./python.exe` on :ref:`most <python.exe>` Mac OS X systems and
+ :file:`PCbuild\\python_d.exe` on Windows).
+4. Make the :doc:`patch <patch>`.
+5. Submit it to the `issue tracker`_.
Quick Links
-----------
-Here are some links that you may find you reference frequently while
+Here are some links that you probably will reference frequently while
contributing to Python.
* `Issue tracker`_
@@ -69,11 +69,11 @@
Contributing
------------
-We encourage everyone to contribute to Python and that's why we have put up
-this developer's guide. If you still have questions after reviewing the
-material in this guide, then the `Python Mentors`_ group is available to help
-guide new contributors through the process. The :doc:`Developer FAQ <faq>` is
-another useful source of information.
+We encourage everyone to contribute to Python and that's why we have put up this
+developer's guide. If you still have questions after reviewing the material in
+this guide, then the `Python Mentors`_ group is available to help guide new
+contributors through the process. The :doc:`Developer FAQ <faq>` is another
+useful source of information.
Guide for contributing to Python:
@@ -98,12 +98,12 @@
* :doc:`devcycle`
* :doc:`buildbots`
-It is **recommended** that the above documents be read in the order listed.
-You can stop where you feel comfortable and begin contributing immediately
-without reading and understanding these documents all at once. If you do
-choose to skip around within the documentation, be aware that it is written
-assuming preceding documentation has been read so you may find it necessary
-to backtrack to fill in missing concepts and terminology.
+It is **recommended** that the above documents be read in the order listed. You
+can stop where you feel comfortable and begin contributing immediately without
+reading and understanding these documents all at once. If you do choose to skip
+around within the documentation, be aware that it is written assuming preceding
+documentation has been read so you may find it necessary to backtrack to fill in
+missing concepts and terminology.
Proposing changes to Python itself
@@ -111,9 +111,9 @@
Improving Python's code, documentation and tests are ongoing tasks that are
never going to be "finished", as Python operates as part of an ever-evolving
-system of technology. An even more challenging ongoing task than these
-necessary maintenance activities is finding ways to make Python, in the form
-of the standard library and the language definition, an even better tool in a
+system of technology. An even more challenging ongoing task than these
+necessary maintenance activities is finding ways to make Python, in the form of
+the standard library and the language definition, an even better tool in a
developer's toolkit.
While these kinds of change are much rarer than those described above, they do
@@ -126,15 +126,14 @@
Other Interpreter Implementations
---------------------------------
-This guide is specifically for contributing to the Python reference
-interpreter, also known as CPython (while most of the standard library is
-written in Python, the interpreter core is written in C and integrates most
-easily with the C and C++ ecosystems).
+This guide is specifically for contributing to the Python reference interpreter,
+also known as CPython (while most of the standard library is written in Python,
+the interpreter core is written in C and integrates most easily with the C and
+C++ ecosystems).
-There are other Python implementations, each with a different focus.
-Like CPython, they always have more things they would like to do than they
-have developers to work on them. Some major example that may be of interest
-are:
+There are other Python implementations, each with a different focus. Like
+CPython, they always have more things they would like to do than they have
+developers to work on them. Some major example that may be of interest are:
* PyPy_: A Python interpreter focused on high speed (JIT-compiled) operation
on major platforms
@@ -153,9 +152,9 @@
Resources
---------
-* Anyone can checkout this guide from http://hg.python.org/devguide/.
- Core developers should use ssh://hg@hg.python.org/devguide instead, so
- that they can push back their edits to the server.
+* Anyone can clone this guide from http://hg.python.org/devguide/. Core
+ developers should use ssh://hg@hg.python.org/devguide instead, so that they
+ can push back their edits to the server.
* Coding style guides
* :PEP:`7` (Style Guide for C Code)
* :PEP:`8` (Style Guide for Python Code)
@@ -181,6 +180,7 @@
* `python.org maintenance`_
* :doc:`developers`
+* :ref:`Search this guide <search>`
.. _Buildbot status: http://python.org/dev/buildbot/
.. _Firefox search engine plug-in: http://www.python.org/dev/searchplugin/
@@ -193,14 +193,3 @@
.. _IronPython: http://ironpython.net/
.. _Stackless: http://www.stackless.com/
.. _Issue tracker: http://bugs.python.org/
-
-
-Indices and tables
-==================
-
-.. XXX commented until non-empty
- * :ref:`genindex`
- * :ref:`modindex`
-
-* :ref:`search`
-
--
Repository URL: http://hg.python.org/devguide
More information about the Python-checkins
mailing list