Author: Rami Chowdhury <[email protected]>
Branch: improve-docs
Changeset: r66388:77fade6cb02c
Date: 2013-08-28 13:48 +0100
http://bitbucket.org/pypy/pypy/changeset/77fade6cb02c/

Log:    Better phrasing, more links in architecture & introduction documents

diff --git a/pypy/doc/architecture.rst b/pypy/doc/architecture.rst
--- a/pypy/doc/architecture.rst
+++ b/pypy/doc/architecture.rst
@@ -3,8 +3,9 @@
 
 .. contents::
 
-This document gives an overview of the goals and architecture of PyPy.
-See :doc:`getting started <getting-started>` for a practical introduction and 
starting points.
+This document gives an overview of the goals and architecture of PyPy. If 
you're
+interested in :ref:`using PyPy <using-pypy>` or :ref:`hacking on it 
<developing-pypy>`,
+have a look at our :ref:`getting started <getting-started-index>` section.
 
 
 Mission statement
diff --git a/pypy/doc/introduction.rst b/pypy/doc/introduction.rst
--- a/pypy/doc/introduction.rst
+++ b/pypy/doc/introduction.rst
@@ -2,7 +2,7 @@
 =============
 
 In common parlance, PyPy has been used to mean two things.  The first is the
-:doc:`RPython translation toolchain <rpython:translation>`, which is a 
framework for generating
+:ref:`RPython translation toolchain <rpython:rpython>`, which is a framework 
for generating
 dynamic programming language implementations.  And the second is one
 particular implementation that is so generated --
 an implementation of the Python_ programming language written in
@@ -11,12 +11,18 @@
 This double usage has proven to be confusing, and we are trying to move
 away from using the word PyPy to mean both things.  From now on we will
 try to use PyPy to only mean the Python implementation, and say the
-:doc:`RPython translation toolchain <rpython:translation>` when we mean the 
framework.  Some older
-documents, presentations, papers and videos will still have the old
+:ref:`RPython translation toolchain <rpython:rpython>` when we mean the 
framework.
+
+Some older documents, presentations, papers and videos will still have the old
 usage.  You are hereby warned.
 
 We target a large variety of platforms, small and large, by providing a
 compiler toolsuite that can produce custom Python versions.  Platform, memory
 and threading models, as well as the JIT compiler itself, are aspects of the
 translation process - as opposed to encoding low level details into the
-language implementation itself. :doc:`more... <architecture>`
+language implementation itself.
+
+For more details, have a look at our :doc:`architecture overview 
<architecture>`.
+
+.. _Python: http://python.org
+.. _
_______________________________________________
pypy-commit mailing list
[email protected]
http://mail.python.org/mailman/listinfo/pypy-commit

Reply via email to